2.2 - Boleto change

ChangeBoleto

API Method = ChangeBoleto

The change in payment slips is necessary when the data in the slip is not consistent with the billing data (values or due date).
In view of this, FitBank's Collection API offers beneficiary clients the ChangeBoleto method capable of changing the following information:

  • Due Date - ChangeDueDateBoleto
  • Principal Value - ChangePrincipalValueBoleto
  • Rebate Value - ChangeRebateBoleto

Each information is related to an InstructionType, which defines what the beneficiary is changing. In addition, the method can contain from 1 to N InstructionType, enabling the boleto to have N information changed simultaneously.

The ChangeBoleto method will return a protocol number, which will be used to query whether the change instructions have taken effect. Each request sending is associated with a protocol number, independent of the numbers of instructions sent. If instructions to change the same boleto are sent in a new request, a new protocol number will be generated.

Important:

  • Only issued or registered boletos can be changed;
  • Boletos that are in the payment process, settled, or cancelled cannot be altered;
  • Changing boletos works 24/7;
  • Only the beneficiary of the boleto can change it.
{
  "Method": "ChangeBoleto",
  "PartnerId": 836,
  "BusinessUnitId": 1260,
  "DocumentNumber": "123670",
  "TaxNumber": "65489102500168",
  "Changes": [
    {  
      "Type": "ChangeDueDateBoleto",
      "Value": "31/03/2023"
    },
    {  
      "Type": "ChangePrincipalValueBoleto",
      "Value": "10"
    },
    {  
      "Type": "ChangeRebateBoleto",
      "Value": "0.5"
    }
  ]
}

Description

ParameterTypeDescriptionMandatory
Method String ChangeBoletoYES 
PartnerId Long FitBank provided IDYES 
BusinessUnitId Long FitBank provided IDYES 
DocumentNumber String Internal transaction identifierYES 
TaxNumber String Payee's TaxNumberYES 
Changes Object-YES 
Type String Instruction type:
ChangeDueDateBoleto
ChangePrincipalValueBoleto 
ChangeRebateBoleto
YES 
Value String Change ValueYES 

Changing the due date of boleto

The customer will be able to change and insert the value of the new due date of the invoice sent in the object Changes a InstructionType ChangeDueDateBoleto.

Changing the principal value of the boleto

If the customer issues a boleto with a wrong amount or different from what he wants, he can change it with the InstructionType ChangePrincipalValueBoleto, in the ChangeBoleto method. The amount can be modified without having to change the interest, penalty and discount fields.

Changing the rebate boleto

After issuing a boleto, the customer can change the rebate amount with InstructionType ChangeRebateBoleto.

GetChangeBoleto

The GetChangeBoleto method allows you to query whether the change instructions sent via the ChangeBoleto method were successfully effected. Return status:

  • Created - Change instruction created
  • Sending - Change instruction is being sent to register
  • Sent - Instruction sent to register
  • Processed - Instruction completed successfully
  • Error - The change instruction was not carried out.
{
  "Method": "GetChangeBoleto",
  "PartnerId": 836,
  "BusinessUnitId": 1260,
  "TaxNumber": "65489102500168",
  "ProtocolNumber": 102
}

Description

ParameterTypeDescriptionMandatory
Method String GetChangeBoletoYES
PartnerId Long FitBank provided IDYES
BusinessUnitId Long FitBank provided IDYES 
TaxNumerString Payee's CPN/CNPJYES 
ProtocolNumberString Protocol number returned on response from the ChangeBoleto methodYES