9 - Cadastro de Favorecido

Scopes:

api.pix api.favorecidopix.cadastrar

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.

Show Descrição dos campos da requisição

Campo	Tipo	Descrição
contaDto	object	Objeto detalhado da conta bancária.
agencia	string	Número da agência bancária.
agenciadígito	string	Dígito verificador da agência bancária.
conta	string	Número da conta bancária.
contadígito	string	Dígito verificador do número da conta bancária.
contaPgto	string	Número da conta bancária seguido do dígito verificador.
tipoConta	integer	Tipo da conta bancária. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário.
modeloConta	integer	Modelo da conta bancária. 1 para Movimento, 2 para Escrow, 3 para Pagamento e 4 para Salário.
nome	string	Nome completo do favorecido.
documentoFederal	string	Número do CPF ou CNPJ do favorecido.
tipoChave	integer	0 para CPF, 1 para CNPJ, 2 para Telefone, 3 para Email e 4 para EVP.
chave	string	Chave PIX para identificação do favorecido.
numeroParticipanteSpi	string	Número do participante no Sistema de Pagamentos Instantâneos (SPI) do favorecido, usado para identificar a instituição bancária.
agencia	string	Número da agência bancária do favorecido.
agenciaDigito	string	Dígito verificador da agência bancária do favorecido.
conta	string	Número da conta bancária do favorecido.
contaDigito	string	dígito verificador do número da conta bancária do favorecido.
contaPagamento	string	Número da conta bancária do favorecido seguido do dígito verificador.
tipoConta	integer	Tipo da conta bancária do favorecido. 1 para Corrente, 2 para Poupança, 3 para Pagamento e 4 para Salário.
tipoCadastroPix	integer	1 para chave e 2 para dados bancários.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

Chave única para garantir que uma operação seja executada apenas uma vez.

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

contaDto · object

Objeto detalhado da Conta Bancária.

Show child attributes

nome · string | null

Nome Completo do Favorecido.

documentoFederal · string | null

CPF ou CNPJ do Favorecido.

numeroBanco · integer | null

Código identificador do Banco. Ex: 001 para Banco do Brasil, etc...

agencia · string | null

Número da Agência da Conta Bancária.

agenciaDigito · string | null

Dígito verificador da Agência da Conta Bancária.

conta · string | null

Número da Conta Bancária.

contaDigito · string | null

Dígito verificador da Conta Bancária.

contaPagamento · string | null

Combinação do Número da Conta + Dígito da Conta, sem espaços ou caracteres especiais.

tipoConta · enum<integer>

1 = CACC; 2 = SVGS; 3 = TRAN; 4 = SLRY

Available options:

1,

2,

3,

4

Response

200 - application/json

Success

sucesso · boolean

Indica se a operação foi realizada com sucesso.

mensagem · string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

jsonErros · string | null

Informações de erro no formato JSON.

codigoFavorecido · string<uuid>

Código identificador do Favorecido.