Pular para o conteúdo principal
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>"
  },
  "nome": "<string>",
  "documentoFederal": "<string>",
  "numeroBanco": 123,
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "conta": "<string>",
  "contaDigito": "<string>",
  "contaPagamento": "<string>"
}
'
{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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.

Autorizações

​
Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Cabeçalhos

​
IdempotencyKey
string
obrigatório
​
IgnoraHandshake
boolean
padrão:true
obrigatório

(somente em homologação)

Corpo

​
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

Opções disponíveis:
1,
2,
3,
4

Resposta

Success

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