2.3 - Electronic Payer Exclusion

Electronic Payer Exclusion

The CancelElectronicPayer method is responsible for deleting the Electronic Payer from the DDA. Once the user requests this exclusion, all accounts associated with the TaxNumber provided will be removed from the DDA, so they will no longer have access to consulting boletos issued in their name.

It can take up to 1 day for the user's exclusion as an electronic payer to take effect. Once completed, the user will receive a webhook confirming the exclusion.

{
  "Method": "CancelElectronicPayer",
  "PartnerId": 12334,
  "BusinessUnitId": 12615,
  "TaxNumber": "12345678910"
}

{
  "Success": "true",
  "Message": "Solicitação de exclusão de pagador eletrônico realizada com sucesso!"
}

Request Parameters

Field	Type	Required	Description
`Method`	string	Yes	Must be `CancelElectronicPayer`
`PartnerId`	integer	Yes	Partner identifier
`BusinessUnitId`	integer	Yes	Business unit identifier
`TaxNumber`	string	Yes	CPF or CNPJ of the electronic payer

Success Response

{
  "Success": true,
  "Message": "Solicitação de exclusão de pagador eletrônico realizada com sucesso!"
}

Error Responses

In inclusion process:

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

Already in exclusion process:

{
  "Success": false,
  "Message": "O pagador Eletrônico informado está em processo de exclusão"
}

Already cancelled:

{
  "Success": false,
  "Message": "O pagador Eletrônico informado já foi excluído anteriormente"
}

Not found:

{
  "Success": false,
  "Message": "O CPF/CNPJ fornecido não consta como pagador eletrônico. Por favor, revise seus dados."
}