Simulate loan booking

Simulate booking a loan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body.

disbursement
array of objects
required
length between 1 and 10

Disbursement due dates

disbursement*
date
required

Loan payment due date. Format = YYYY-MM-DD.

double
required

Amount of money that the applicant is borrowing. If restructured_loan_id is provided, the outstanding balance of the restructured loan is added to loan_amount.

string
required
length ≤ 80

Loan product ID. Accepts either a lowercase UUID (e.g., "2717a296-124a-47cc-b2a1-91e80dc723eb") or an uppercase alphanumeric string with underscores (e.g., "MY_LOAN_PRODUCT_001"). If not provided during creation, a UUID is auto-generated.

stages
array of objects
required
length between 1 and 5

How chosen interest rate affects loan interval

stages*
interest_rate
object
required

Interest rate applied in the stage

period
object
required

Number of time periods for the stage

date
required

Loan start date. Format = YYYY-MM-DD.

string
length ≤ 36

Custom ID for the simulation. Must consist of uppercase alphanumeric characters and underscores.

string
length ≤ 50

External ID

uuid

Restructured loan ID

Headers
uuid

Idempotency key

Responses

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