48 - Favored Registration

Scopes:

api.pix api.favorecidopix.cadastrar

Cadastra um Favorecido

cURL

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
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "jsonErros": "<string>",
  "codigoFavorecido": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

The API is responsible for creating favored ones for accounts and payments.

Show Request fields description

Field	Type	Description
agenciaDigito	string	Bank branch check digit.
conta	string	Bank account number.
contaDigito	string	Bank account number check digit.
contaPgto	string	Bank account number followed by the check digit.
tipoConta	integer	Bank account type. 1 for Checking, 2 for Savings, 3 for Payment, and 4 for Payroll.
modeloConta	integer	Bank account model. 1 for Movement, 2 for Escrow, 3 for Payment, and 4 for Payroll.
nome	string	Full name of the beneficiary.
documentoFederal	string	CPF or CNPJ number of the beneficiary.
numeroBanco	integer	Bank identifier code. Example: 001 for Banco do Brasil.
agencia	string	Beneficiary’s bank branch number.
agenciaDigito	string	Beneficiary’s bank branch check digit.
conta	string	Beneficiary’s bank account number.
contaDigito	string	Beneficiary’s bank account number check digit.
contaPagamento	string	Beneficiary’s bank account number followed by the check digit.

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.*

Show child attributes

contaDto. agencia · string | null

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

Observações:

• O número da agência pode ter no máximo 4 caracteres.

contaDto. agenciaDigito · string | null

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

Observações:

• O dígito verificador da agência bancária pode ter no máximo 1 caracter.

contaDto. conta · string | null

Número da conta bancária.

Observações:

• O número da conta bancária pode ter no máximo 12 caracteres.
• Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
• Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
• Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.

contaDto. contaDigito · string | null

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

Observações:

• O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.

contaDto. contaPgto · string | null

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

Observações:

• O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.

contaDto. tipoConta · enum<integer>

Tipo da conta.*

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

Available options: 1, 2, 3, 4

contaDto. modeloConta · enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Available options: 1, 2, 3

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

200

application/json

Success

sucesso · boolean

mensagem · string | null

jsonErros · string | null

codigoFavorecido · string<uuid>