Exemplo de Requisição
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>",
"tipoConta": 1,
"modeloConta": 1
},
"nome": "<string>",
"documentoFederal": "<string>",
"numeroBanco": 123,
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPagamento": "<string>",
"tipoConta": 1
}'
Exemplos de Resposta
200 OK
{
"sucesso": true,
"mensagem": "<string>",
"jsonErros": "<string>",
"codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
400 Bad Request
{
"sucesso": true,
"mensagem": "<string>"
}
500 Internal Server Error
{
"sucesso": true,
"mensagem": "<string>"
}
Descrição dos campos da requisição
ObjetocontaDto:
| Campo | Tipo | Descrição | Observações |
|---|---|---|---|
| agencia | string | Número da agência bancária. | Até 4 caracteres. |
| agenciaDigito | string | Dígito verificador da agência bancária. | Apenas 1 caractere. |
| conta | string | Para localizar a conta, informe contaPgto ou ambos conta e contaDigito; se nenhum for informado, a requisição falhará por falta de dados essenciais. | Até 12 caracteres. |
| contaDigito | string | Dígito verificador do número da conta bancária. | Apenas 1 caractere. |
| contaPgto | string | Número da conta bancária seguido do dígito verificador. | Até 20 caracteres. |
| tipoConta | integer | Tipo da conta bancária. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário. | Apenas 1 caractere. |
| modeloConta | integer | Modelo da conta bancária. 1 para Movimento, 2 para Escrow e 3 para Vinculada. | Apenas 1 caractere. |
| Campo | Tipo | Descrição |
|---|---|---|
| nome | string | Nome completo do favorecido. |
| documentoFederal | string | Número do CPF ou CNPJ do favorecido. |
| numeroBanco | integer | Código identificador do banco. Exemplo: 001 para Banco do Brasil. |
| 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. |
Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:
| Endpoint | Mensagem de erro |
|---|---|
| /api/Favorecido | Operador não configurado para esta integração |
| /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | Situação da conta inválida |
| /api/Favorecido | Conta != Ativa |
| /api/Favorecido | Operador não encontrado |
| /api/Favorecido | Parceiro não autorizado para esta conta |
| /api/Favorecido | É necessário informar o número banco |
| /api/Favorecido | Conta inexistente |
| /api/Favorecido | Banco inexistente |
| /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada |
| /api/Favorecido | É necessário informar o Nome |
| /api/Favorecido | É necessário informar um Tipo Conta |
| /api/Favorecido | É necessário informar uma Agência |
| /api/Favorecido | É necessário informar uma Conta Pagamento |
| /api/Favorecido | É necessário informar uma Conta - Dígito” |
| /api/Favorecido | Documento federal inválido |
| /api/Favorecido | Tipo Chave inválido |
| /api/Favorecido | Informe uma chave válida! |
| /api/Favorecido | É necessário informar um Tipo Cadastro Pix |
| /api/Favorecido | Documento Federal inválido |
| /api/Favorecido | Parceiro não encontrado |
| /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
| /api/Favorecido | O código do banco deve ser informado |
| /api/Favorecido | A conta informada não existe ou está inativa |
| /api/Favorecido | Correntista do favorecido não encontrado |
| /api/Favorecido | O nome informado é diferente ao titular da conta |
| /api/Favorecido | O documento federal informado é diferente ao titular da conta |
| /api/Favorecido | Documento está em cadastro restritivo |
| /api/Favorecido | Favorecido já está cadastrado |
| /api/Favorecido | Favorecido está pendente aprovação |
| /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido |
| /api/Favorecido | Favorecido encaminhado para análise |
| /api/Favorecido | Favorecido cadastrado com sucesso |
| /api/Favorecido | Favorecido encaminhado para análise |
| /api/Favorecido | Favorecido cadastrado com sucesso |
| /api/Favorecido | Operador não configurado para esta integração |
| /api/Favorecido | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Favorecido | Conta inválida |
| /api/Favorecido | Situação da conta inválida |
| /api/Favorecido | Conta != Ativa |
| /api/Favorecido | Operador não encontrado |
| /api/Favorecido | Parceiro não autorizado para esta conta |
| /api/Favorecido | É necessário informar o Código Favorecido |
| /api/Favorecido | É necessário informar o número banco |
| /api/Favorecido | Conta inexistente |
| /api/Favorecido | Banco inexistente |
| /api/Favorecido | Não foi possível cadastrar o favorecido. A conta está bloqueada |
| /api/Favorecido | É necessário informar o Nome |
| /api/Favorecido | É necessário informar um Tipo Conta |
| /api/Favorecido | É necessário informar uma Agência |
| /api/Favorecido | É necessário informar uma Conta Pagamento |
| /api/Favorecido | É necessário informar uma Conta - Dígito” |
| /api/Favorecido | Documento federal inválido |
| /api/Favorecido | Tipo Chave inválido |
| /api/Favorecido | Informe uma chave válida! |
| /api/Favorecido | É necessário informar um Tipo Cadastro Pix |
| /api/Favorecido | Documento Federal inválido |
| /api/Favorecido | Parceiro não encontrado |
| /api/Favorecido | Não foi possível concluir a transferência. \nO destinatário informado não é válido para este tipo de operação |
| /api/Favorecido | O código do banco deve ser informado |
| /api/Favorecido | A conta informada não existe ou está inativa |
| /api/Favorecido | Correntista do favorecido não encontrado |
| /api/Favorecido | O nome informado é diferente ao titular da conta |
| /api/Favorecido | O documento federal informado é diferente ao titular da conta |
| /api/Favorecido | Documento está em cadastro restritivo |
| /api/Favorecido | Favorecido já está cadastrado |
| /api/Favorecido | Favorecido está pendente aprovação |
| /api/Favorecido | Não foi possível inserir ou atualizar o Favorecido |

