Simulate prepayment

Simulate a prepayment for a loan using the prepayment engine.

The response includes the resulting balance breakdown, the new repayment schedule, and a simulation_id that can later be used to register the prepayment via POST /v2/loans/{loanId}/prepayment/{simulationId}/register.

This endpoint generates a Lending prepayment creation event.

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

ID of the loan the operation applies to

Body Params
double
required
≥ 0

Prepayment amount

date

Reference date used to compute the prepayment. When omitted, the platform sets the value to the current date. Format = YYYY-MM-DD.

boolean

When omitted, the Pismo platform sets the value to false. Should the fees applied to this prepayment be waived?

string
enum
required

Defines the way that the outstanding loan amount is reduced.

Allowed:
Headers
uuid

Optional UUID that makes the request idempotent, enabling you to retry it multiple times while the system processes it only once.

Responses

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