Por meio deste endpoint, o parceiro pode solicitar o cadastro do favorecido, ou seja, quem receberá os valores transferidos através de chave PIX ou dados bancários.

Após realizar a solicitação, o time do Banco Digital realizará a análise do favorecido e seguir com a aprovação ou rejeição caso tenha algum apontamento.

Caso o parceiro queira optar por aprovação automática do favorecido precisa ser solicitado via chamado na plataforma Heflo ao time do Banco Digital, lembrando que isso não isenta a possibilidade de reprovação caso ocorra algum apontamento no favorecido.

​
Exemplo de requisição

curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Favorecido \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '{
  "contaDto": {
    "agencia": "stri",
    "agenciaDigito": "s",
    "conta": "string",
    "contaDigito": "s",
    "contaPgto": "string",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "nome": "string",
  "documentoFederal": "string",
  "tipoChave": 0,
  "chave": "string",
  "numeroParticipanteSpi": "string",
  "agencia": "stri",
  "agenciaDigito": "s",
  "conta": "string",
  "contaDigito": "s",
  "contaPagamento": "string",
  "tipoConta": 1,
  "tipoCadastroPix": 1
}'
CampoTipoDescrição
contaDtoobjectObjeto detalhado da conta bancária.
agenciastringNúmero da agência bancária.
agenciadígitostringDígito verificador da agência bancária.
contastringNúmero da conta bancária.
contadígitostringDígito verificador do número da conta bancária.
contaPgtostringNúmero da conta bancária seguido do dígito verificador.
tipoContaintegerTipo da conta bancária. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário.
modeloContaintegerModelo da conta bancária. 1 para Movimento, 2 para Escrow, 3 para Pagamento e 4 para Salário.
nomestringNome completo do favorecido.
documentoFederalstringNúmero do CPF ou CNPJ do favorecido.
tipoChaveinteger0 para CPF, 1 para CNPJ, 2 para Telefone, 3 para Email e 4 para EVP.
chavestringChave PIX para identificação do favorecido.
numeroParticipanteSpistringNúmero do participante no Sistema de Pagamentos Instantâneos (SPI) do favorecido, usado para identificar a instituição bancária.
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.
tipoCadastroPixinteger1 para chave e 2 para dados bancários.