PIpismo
Prepayment

Register prepayment simulation

Register a previously calculated prepayment simulation, applying it to the loan. The request body is optional and is only used to override the processing codes used to record the prepayment, penalty, and insurance movements in the prepayment workflow.

This endpoint generates a Lending prepayment status changed event.

post/v2/loans/{loanId}/prepayment/{simulationId}/register

Request

  • Base URL
    https://sandbox.pismolabs.io/lending
  • URL
    https://sandbox.pismolabs.io/lending/v2/loans/{loanId}/prepayment/{simulationId}/register
  • Auth
    HTTP bearer

Path parameters

loanIdstring uuid required

ID of the loan the operation applies to

simulationIdstring uuid required

Prepayment simulation ID returned by the simulate endpoint

Headers

Idempotency-Keystring uuid

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

Request body

insurance_processing_codestring

Processing code used to register the insurance movement in the prepayment flow

penalty_processing_codestring

Processing code used to register the penalty movement in the prepayment flow

prepayment_processing_codestring

Processing code used to register the prepayment movement in the prepayment flow.

Example request

{
  "insurance_processing_code": "INSR",
  "penalty_processing_code": "PNLT",
  "prepayment_processing_code": "PPMT"
}

Response

Prepayment registration accepted.

loan_idstring uuid

ID of the loan the registered simulation applies to

simulation_idstring uuid

Prepayment simulation ID

statusstring

Current registration status of the simulation

Example response

{
  "loan_id": "2717a296-124a-47cc-b2a1-91e80dc723eb",
  "simulation_id": "c04fd22b-7d9c-4099-aaf4-9ee002b5a6a7",
  "status": "PROCESSING"
}

Changes

No recorded changes to this operation across all 1 revision of this API.