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
}'
{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Through this endpoint, partners can request the registration of a beneficiary, that is, the person who will receive funds transferred via Pix key or bank account details.

After submitting the request, the Digital Bank team will review the beneficiary and proceed with approval or rejection if there are any issues. If the partner prefers automatic beneficiary approval, this must be requested through a ticket on the Heflo platform to the Digital Bank team. However, this does not exempt the possibility of rejection if any issues arise with the beneficiary.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Headers

IdempotencyKey
string
required
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

Response

200 - application/json

Success

The response is of type object.