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

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//installment-plan endpoint.

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

Path Params
string
required
Body Params
integer
required

Number of installments

string
enum
Allowed:
integer
Defaults to 0

Any extra fees bound to recollection procedure

string
enum
Allowed:
date-time
required

First installment date

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*