latestSwagger 2.02026-08-2181213270.0 KB

0a9c1f8784f2

Recollection

Simulate an installment plan

Before creating an installment plan you might need to expose installment amounts & dates to your debtor so that you can find the right agreement. This endpoint will help you achieving such simulation.

To use this endpoint, you'll need to provide the list of loans or bills you want to repay with proposed plan. Then select plan starting date and periodicity. The system automatically returns a plan avoiding avoiding bank holidays and weekends and explicitly, enlists loans paid on every installment & gives the lettering of each installment.

The returned payload will serve as an input for POST /recollection-case/<id>/installment-plan endpoint.

Note: The recollection_fees amount allows you to add an arbitrary amount to the proposed installment plan. See POST /recollection-case/<id>/installment-plan endpoint.

post/recollection-case/{recollection_case_id}/installment-plans/compute

Path parameters

recollection_case_idstring required

Request body

number_of_installmentinteger required

Number of installments

period'biweekly' | 'monthly' | 'weekly'
recollection_feesinteger

Any extra fees bound to recollection procedure

repayment_method'DIRECT_DEBIT' | 'P2P' | 'SCT'
start_datestring date-time required

First installment date

Response

OK