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

Allow repaying in multiple times

This endpoint is dedicated to the creation of an installment plan as part of recollection strategy.
You'll need a recollection-case id to use this endpoint.

In the event of insolvency, your debtor can opt for an installment plan to repay his debt with smaller
recurring pamyents. This smoothens the repayment effort, allowing the debtor to reimburse selected
loans or bills progressively.

the value of the installment parameter must be obtained by calling the POST /installment-plan/compute
endpoint.

The repayment_method field allows you to decide between direct-debit and sepa credit transfer.
If you pick DIRECT_DEBIT, the debited account will reuse borrower's main repayment account.
cf. GET /borrower/{borrower_id}/repayment-methods endpoint

We know recollection process has costs, for this reason the recollection_fees field permits adding
an arbitrary amount to proposed installment plan. This amount can cover recollection expenses
for example. When recollection_fees are collected, they are paid-out to the partner later.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
installments
array of objects
required

List of installments in installment plan

installments*
string
enum
required

Payment method to use for requested installment plan

Allowed:
Headers
uuid
required

UUID of an approved governance Decision whose planned_operations list this endpoint together with the exact request payload. The matching planned step must not yet have been executed. Planned operations may contain {{step.<n>.json.<path>}} references to earlier steps' responses: the gate resolves them against the recorded outputs before matching, so send the RESOLVED body and fire steps in order — a step whose references are not yet resolvable cannot match. Required for MCP callers; HumanReviewer callers bypass the gate by default.

Responses

400

Missing X-Decision-Id header or value is not a valid UUID.

403

Decision is not approved, the calling identity does not match the proposer, no planned operation matches this endpoint + payload, the matching step has already been executed, or the caller is not a recognised proposing Operator.

404

No Decision exists for the supplied X-Decision-Id.

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