On this page
Repayments and charges
Create a collection and a schedule#
Send POST /api/v1/collections/clients/{customer}/collection after establishing the customer and authorization flow. Send amount, startDate, intervalType, tenureType, and tenureValue. You can send explicit instalments, each with an amount and charge_date.start. Provide charge_date.end for a window. Use a start date after today. A fixed interval requires endDate. Date ranges require intervalValue.start and intervalValue.end as ordered days of the month from 1 to 30.
Interval types are daily, weekly, monthly, date_range, specific_days, day_intervals, and fixed. Tenure types are days, weeks, months, years, and fixed. Schedule preview and date utilities are listed in the API Reference.
Update a charge#
To edit the amount or upcoming charge window of an existing instalment, use PATCH /api/v1/collections/clients/collection/{collection}/instalment/{instalment}. The update request accepts amount and charge_date. When changing the window, supply a future charge_date.start and, if applicable, an end date after the start. Fetch the collection afterward to verify the persisted schedule.
Use a lifecycle event when the change represents an external payment, discount, write-off, or fee. Use the transaction lookup endpoints when you need to check an existing debit attempt.
Initiate a debit and reconcile repayments#
Use a scheduled instalment or request an immediate attempt using GET /api/v1/collections/clients/instalments/{instalment}/charge. This route can initiate a debit. Call it only in response to an authorized charge operation. Verify transaction status by reference before treating a charge as settled or requesting another attempt. A partial debit can leave an outstanding instalment balance. Collections calculates subsequent attempts from the remaining amount. Fetch the lifecycle snapshot to determine what remains collectible.
If payment came through bank transfer, cash, or another provider, record a payment lifecycle event against the correct instalment. Use a stable event ID from your payment system. The remaining balance and next eligible debit are available in the lifecycle snapshot.