Skip to main content
Cadastra um novo favorecido para transações Pix.
curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.com.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>",
  "tipoChave": 0,
  "chave": "<string>",
  "numeroParticipanteSpi": "<string>",
  "agencia": "<string>",
  "agenciaDigito": "<string>",
  "conta": "<string>",
  "contaDigito": "<string>",
  "contaPagamento": "<string>",
  "tipoConta": 1,
  "tipoCadastroPix": 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.*

​
documentoFederal
string | null

Número do CPF ou CNPJ do Favorecido.*

​
tipoChave
enum<integer>

Tipo da chave.*

Valores: 0 - CPF 1 - CNPJ 2 - TELEFONE 3 - EMAIL 4 - EVP

Available options:
0,
1,
2,
3,
4
​
chave
string | null

Chave Pix para identificação do favorecido.*

Observações:

  • Para cadastrar um novo favorecido, é necessário informar uma 'chave Pix' (chave) ou os dados bancários correspondentes.
  • Para informar os dados bancários de uma conta pagamento, preencha os campos 'número da agência' (agencia) e o 'número da conta com dígito' (contaPagamento).
  • Para informar os dados bancários de uma conta de outro tipo, preencha os campos 'número da agência' (agencia), o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
​
numeroParticipanteSpi
string | null

Número do participante no SPI (Sistema de Pagamentos Instantâneos), usado para identificar a instituição bancária.*

​
agencia
string | null

Número da agência bancária do favorecido.*

​
agenciaDigito
string | null

Dígito verificador da agência bancária do favorecido.*

​
conta
string | null

Número da conta bancária do favorecido.*

​
contaDigito
string | null

Dígito verificador do número da conta bancária do favorecido.*

​
contaPagamento
string | null

Número da conta bancária do favorecido seguido do dígito verificador.*

​
tipoConta
enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Available options:
1,
2,
3,
4
​
tipoCadastroPix
enum<integer>

Tipo de cadastro pix.*

Valores: 1 - Chave 2 - DadosBancarios

Available options:
1,
2

Response

200 - application/json

Success

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