2.1 - Electronic Payer Inclusion

Electronic Payer Inclusion

The AddElectronicPayer method is used to include a user as an Electronic Payer in the DDA. Electronic Payers will have access to boletos issued in their name by any institution.

To be an Electronic Payer, you must have a Verified account; accounts that do not meet this criterion are not eligible for inclusion as an Electronic Payer.

In the AddElectronicPayer method, the user must provide at least one account (using SPB data), and can add from 1 to N accounts.

It can take up to a day for the user to be included as an electronic payer. Once completed, the user will receive a webhook confirming their inclusion.

Accept

The "WasSigned" field refers to the user's acceptance of becoming an electronic payer.

If the user wants the DDA service, which currently includes the functionality to consult boletos issued in their name, then they must fill in the field as "True".
If they choose not to use the DDA service, they must enter "False".

{
  "Method": "AddElectronicPayer",
  "PartnerId": 12334,
  "BusinessUnitId": 12615,
  "TaxNumber": "12345678910",
  "WasSigned": true,
  "Accounts": [
    {
      "Bank": "450",
      "BankBranch": "1",
      "Account": "112233445",
      "AccountDigit": "6"
    }
  ]
}

Request Parameters

Field	Type	Required	Description
`Method`	string	Yes	Must be `AddElectronicPayer`
`PartnerId`	integer	Yes	Partner identifier
`BusinessUnitId`	integer	Yes	Business unit identifier
`TaxNumber`	string	Yes	CPF (11 digits) or CNPJ (14 digits) of the payer
`WasSigned`	boolean	Yes	Electronic Payer Acceptance. If True, then the user accepts to be an electronic payer If False, then the user does not accept to be an electronic payer
`Accounts`	array	Yes	List of bank accounts to be linked
`Bank`	string	Yes	Bank code
`BankBranch`	string	Yes	Bank branch number
`Account`	string	Yes	Account number
`AccountDigit`	string	Yes	Account check digit

Success Response

{
  "Success": true,
  "Message": "A solicitação para inclusão do pagador eletrônico foi enviada com sucesso"
}

Error Responses

Already in inclusion process:

{
  "Success": false,
  "Message": "O Pagador Eletrônico encontra-se em processo de inclusão."
}

Already exists:

{
  "Success": false,
  "Message": "Já existe um pagador eletrônico registrado para este CPF/CNPJ. Por favor, tente novamente com um CPF/CNPJ diferente ou entre em contato com o suporte se precisar de ajuda."
}

Invalid CPF/CNPJ:

{
  "Success": false,
  "Message": "CPF/CNPJ inválido"
}

Validation error:

{
  "Success": false,
  "Message": "ISE0014 - Informações enviadas estão inválidas. Veja a propriedade Validation do json para mais detalhes.",
  "Validation": [
    {
      "Key": "TaxNumber",
      "Value": ["Campo obrigatório"]
    }
  ]
}