PIpismo
Early final settlement

Register early final settlement

Register an early final settlement (EFS) for a loan using a previously simulated EFS ID.

post/v2/loans/{loanId}/early-settlement/{efsId}/register

Request

  • Base URL
    https://sandbox.pismolabs.io/lending
  • URL
    https://sandbox.pismolabs.io/lending/v2/loans/{loanId}/early-settlement/{efsId}/register
  • Auth
    HTTP bearer

Path parameters

loanIdstring uuid required

ID of the loan the operation applies to

efsIdstring uuid required

Early final settlement simulation ID

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.

Response

Early final settlement registration accepted

early_settle_idstring uuid required

Early settlement ID

total_settlednumber double required

Total amount settled for the loan

Example response

{
  "early_settle_id": "72852338-5764-4c7e-b503-10dcee1cdb7e",
  "outstanding": {
    "charge": 10,
    "fee": 10,
    "installments": 5,
    "interest": 20,
    "penalty": 100,
    "principal": 2000,
    "tax": 10
  },
  "total_settled": 1584
}

Changes

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