5 - Changing

Changing a Collection Order

API Method = ChangeCollectionOrder

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 ChangeCollectionOrder method capable of changing the following information:

  • Due Date
  • Principal Value
  • Rebate Value
  • Fine Date

Important:

  • Only issued or registered Collection Orders can be changed;
  • Collection Orders that are in the payment process, settled, or cancelled cannot be altered;
  • Changing Collection Orders works 24/7;
{
  "Method": "ChangeCollectionOrder",
  "PartnerId": 147,
  "BusinessUnitId": 205,
  "DocumentNumber": 15722,
  "Changes": {
    "DueDate": "2025-03-31",
    "FineDate": "2025-10-29",
    "PrincipalValue": 100,
    "RebateValue": 0.1
  }
}
{
  "Success": "true",
  "Message": "ISI0019 - Collection order change successfully submitted"
}

Description

ParameterDescriptionMandatoryTypeComments
MethodName of the method to be usedYESSTRINGNone
PartnerIdPartner identifier provided by FitBankYESBIGINTNone
BusinessUnitIdBusiness unit identifier provided by FitBankYESBIGINTNone
DocumentNumberOperation document numberYESINTEGERNone
ChangesObjectYESOBJECTAt least one change type must be submitted
DueDate(yyyy/mm/dd)-DateTimeNone
FineDate(yyyy/mm/dd)-DateTimeNone
PrincipalValueValue of the Collection Order-DECIMALNone
RebateValueValue of the Rebate-DECIMALNone