2.4 - Boleto cancellation

Boleto cancellation

The beneficiary may request the cancellation of the boleto at any time, as long as the boleto has only been issued or registered

If the boletos are in the process of payment or have been settled, their cancellation is not possible.

In the API, cancellation is available via the CancelBoleto method, requiring the boleto document number.

In the Client Portal, the beneficiary can access the "Accounts Receivable" screen, where the issued boletos will be listed, and the option to cancel them.


{
    "Method": "CancelBoleto",
    "PartnerId": 896,
    "BusinessUnitId": 1261,
    "DocumentNumber": 684841,
    "RateSent": 1,
    "RateValue": 2.0
}
{
    "Success": "true",
    "Message": "ISI0001 - Método executado com sucesso"
}

Description:

ParameterTypeDescriptionMandatory
Method String CancelBoletoYES 
PartnerId NumberFitBank provided IDYES 
BusinessUnitId NumberFitBank provided IDYES 
DocumentNumber String Internal transaction identifierYES 
RateSentNumber0 - Do not send the cancellation fee and use the parameterized value
1 - send the cancellation fee in the requisition
No
RateValueDecimalBoleto cancellation feeNo, if the RateSent field = 0
Yes, if the RateSent field = 1