curl --request POST \
--url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload = {
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"IgnoraHandshake": "<ignorahandshake>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
IgnoraHandshake: '<ignorahandshake>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contaDto: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
nome: '<string>',
documentoFederal: '<string>',
numeroBanco: 123,
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPagamento: '<string>'
})
};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ext.dbs.moneyp.dev.br/api/Favorecido",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contaDto' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'nome' => '<string>',
'documentoFederal' => '<string>',
'numeroBanco' => 123,
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPagamento' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>",
"IgnoraHandshake: <ignorahandshake>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload := strings.NewReader("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
.header("IdempotencyKey", "<idempotencykey>")
.header("IgnoraHandshake", "<ignorahandshake>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"jsonErros": "<string>",
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}9 - Cadastro de Favorecido
Scopes:
api.pix api.favorecidopix.cadastrarcurl --request POST \
--url https://api.ext.dbs.moneyp.dev.br/api/Favorecido \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
'import requests
url = "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload = {
"contaDto": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>"
},
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>"
}
headers = {
"IdempotencyKey": "<idempotencykey>",
"IgnoraHandshake": "<ignorahandshake>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
IgnoraHandshake: '<ignorahandshake>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contaDto: {
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPgto: '<string>'
},
nome: '<string>',
documentoFederal: '<string>',
numeroBanco: 123,
agencia: '<string>',
agenciaDigito: '<string>',
conta: '<string>',
contaDigito: '<string>',
contaPagamento: '<string>'
})
};
fetch('https://api.ext.dbs.moneyp.dev.br/api/Favorecido', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ext.dbs.moneyp.dev.br/api/Favorecido",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contaDto' => [
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPgto' => '<string>'
],
'nome' => '<string>',
'documentoFederal' => '<string>',
'numeroBanco' => 123,
'agencia' => '<string>',
'agenciaDigito' => '<string>',
'conta' => '<string>',
'contaDigito' => '<string>',
'contaPagamento' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>",
"IgnoraHandshake: <ignorahandshake>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ext.dbs.moneyp.dev.br/api/Favorecido"
payload := strings.NewReader("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
.header("IdempotencyKey", "<idempotencykey>")
.header("IgnoraHandshake", "<ignorahandshake>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.dbs.moneyp.dev.br/api/Favorecido")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contaDto\": {\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPgto\": \"<string>\"\n },\n \"nome\": \"<string>\",\n \"documentoFederal\": \"<string>\",\n \"numeroBanco\": 123,\n \"agencia\": \"<string>\",\n \"agenciaDigito\": \"<string>\",\n \"conta\": \"<string>\",\n \"contaDigito\": \"<string>\",\n \"contaPagamento\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sucesso": true,
"mensagem": "<string>",
"jsonErros": "<string>",
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Mostrar Descrição dos campos da requisição
Mostrar Descrição dos campos da requisição
| Campo | Tipo | Descrição |
|---|---|---|
| contaDto | object | Objeto detalhado da conta bancária. |
| agencia | string | Número da agência bancária. |
| agenciadígito | string | Dígito verificador da agência bancária. |
| conta | string | Número da conta bancária. |
| contadígito | string | Dígito verificador do número da conta bancária. |
| contaPgto | string | Número da conta bancária seguido do dígito verificador. |
| tipoConta | integer | Tipo da conta bancária. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário. |
| modeloConta | integer | Modelo da conta bancária. 1 para Movimento, 2 para Escrow, 3 para Pagamento e 4 para Salário. |
| nome | string | Nome completo do favorecido. |
| documentoFederal | string | Número do CPF ou CNPJ do favorecido. |
| tipoChave | integer | 0 para CPF, 1 para CNPJ, 2 para Telefone, 3 para Email e 4 para EVP. |
| chave | string | Chave PIX para identificação do favorecido. |
| numeroParticipanteSpi | string | Número do participante no Sistema de Pagamentos Instantâneos (SPI) do favorecido, usado para identificar a instituição bancária. |
| agencia | string | Número da agência bancária do favorecido. |
| agenciaDigito | string | Dígito verificador da agência bancária do favorecido. |
| conta | string | Número da conta bancária do favorecido. |
| contaDigito | string | dígito verificador do número da conta bancária do favorecido. |
| contaPagamento | string | Número da conta bancária do favorecido seguido do dígito verificador. |
| tipoConta | integer | Tipo da conta bancária do favorecido. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário. |
| tipoCadastroPix | integer | 1 para chave e 2 para dados bancários. |
Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
| Endpoint | Mensagem de erro |
|---|---|
| /api/Favorecido | Operador não configurado para esta integração |
| /api/Favorecido | Agência inválida |
| /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | Conta pagamento inválida |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | |
| /api/Favorecido | Operador não encontrado |
| /api/Favorecido |
Autorizações
Copie 'Bearer ' + token
Cabeçalhos
(somente em homologação)
Corpo
Objeto detalhado da conta bancária.*
Show child attributes
Show child attributes
Nome completo do favorecido.*
Observação:
- O nome completo do favorecido pode ter no máximo 100 caracteres.
CPF ou CNPJ do favorecido.*
Observação:
- O CPF ou CNPJ do favorecido pode ter no máximo 14 caracteres.
Código identificador do banco. Exemplo: 001 para Banco do Brasil, 104 para Caixa Econômica Federal, etc.*
Número da agência da conta bancária.*
Observação:
- O número da agência da conta bancária pode ter no máximo 10 caracteres.
Dígito verificador da agência da conta bancária.*
Observação:
- O dígito verificador da agência da conta bancária pode ter no máximo 1 caracter.
Número da conta bancária.
Observações:
- Para conta do tipo pagamento, informar o 'número da conta com dígito' (
contaPagamento). - Para conta de outros tipos de informar o 'número da conta' (
conta) e o 'dígito verificador' (contaDigito). - Caso nenhum dos campos referentes ao número da conta sejam informados, ocorrerá erro na requisição devido à falta de informação vital.
- O número da conta bancária pode ter no máximo 12 caracteres.
Dígito verificador da conta bancária.
Observação:
- O dígito verificador da conta bancária pode ter no máximo 1 caracter.
Número da conta bancária seguido do dígito verificador, sem espaços ou caracteres especiais.
Observação:
- O número da conta bancária seguido do dígito verificador pode ter no máximo 20 caracteres.
Tipo de conta.*
Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY
1, 2, 3, 4 Esta página foi útil?

