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
Parameter | Description | Mandatory | Type | Comments |
---|---|---|---|---|
Method | Name of the method to be used | YES | STRING | None |
PartnerId | Partner identifier provided by FitBank | YES | BIGINT | None |
BusinessUnitId | Business unit identifier provided by FitBank | YES | BIGINT | None |
DocumentNumber | Operation document number | YES | INTEGER | None |
Changes | Object | YES | OBJECT | At least one change type must be submitted |
DueDate | (yyyy/mm/dd) | - | DateTime | None |
FineDate | (yyyy/mm/dd) | - | DateTime | None |
PrincipalValue | Value of the Collection Order | - | DECIMAL | None |
RebateValue | Value of the Rebate | - | DECIMAL | None |
Updated 18 days ago