Pular para o conteúdo principal
A API tem a função de criar favorecidos para as contas e pagamentos.

​
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

Objeto contaDto:
CampoTipoDescriçãoObservações
agenciastringNúmero da agência bancária.Até 4 caracteres.
agenciaDigitostringDígito verificador da agência bancária.Apenas 1 caractere.
contastringPara 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.
contaDigitostringDígito verificador do número da conta bancária.Apenas 1 caractere.
contaPgtostringNúmero da conta bancária seguido do dígito verificador.Até 20 caracteres.
tipoContaintegerTipo da conta bancária. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário.Apenas 1 caractere.
modeloContaintegerModelo da conta bancária. 1 para Movimento, 2 para Escrow e 3 para Vinculada.Apenas 1 caractere.
CampoTipoDescrição
nomestringNome completo do favorecido.
documentoFederalstringNúmero do CPF ou CNPJ do favorecido.
numeroBancointegerCódigo identificador do banco. Exemplo: 001 para Banco do Brasil.
agenciastringNúmero da agência bancária do favorecido.
agenciaDigitostringDígito verificador da agência bancária do favorecido.
contastringNúmero da conta bancária do favorecido.
contaDigitostringdígito verificador do número da conta bancária do favorecido.
contaPagamentostringNúmero da conta bancária do favorecido seguido do dígito verificador.
tipoContaintegerTipo da conta bancária do favorecido. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário.