Skip to main content
Cadastra um Favorecido
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, the partner can request the registration of the beneficiary, that is, the person who will receive the funds transferred via PIX key or bank details.
After submitting the request, the Digital Bank team will analyze the beneficiary and proceed with approval or rejection if there are any issues.If the partner wishes to opt for automatic approval of the beneficiary, it must be requested via a ticket on the Heflo platform to the Digital Bank team. Please note that this does not exempt the possibility of rejection if an issue arises for the beneficiary.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required
​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
contaDto
object

Objeto detalhado da conta bancária.*

​
nome
string | null

Nome completo do favorecido.*

Observação:

  • O nome completo do favorecido pode ter no máximo 100 caracteres.
​
documentoFederal
string | null

CPF ou CNPJ do favorecido.*

Observação:

  • O CPF ou CNPJ do favorecido pode ter no máximo 14 caracteres.
​
numeroBanco
integer<int32> | null

Código identificador do banco. Exemplo: 001 para Banco do Brasil, 104 para Caixa Econômica Federal, etc.*

​
agencia
string | null

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.
​
agenciaDigito
string | null

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.
​
conta
string | null

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.
​
contaDigito
string | null

Dígito verificador da conta bancária.

Observação:

  • O dígito verificador da conta bancária pode ter no máximo 1 caracter.
​
contaPagamento
string | null

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.
​
tipoConta
enum<integer>

Tipo de conta.*

Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY

Available options:
1,
2,
3,
4

Response

Success

​
sucesso
boolean
​
mensagem
string | null
​
jsonErros
string | null
​
codigoFavorecido
string<uuid>