Repayment hierarchy

Create repayment hierarchy

Create a repayment hierarchy for a loan. The repayment hierarchy determines the order in which loan components are paid during repayment processing.

post/v2/repayment-hierarchies

Request

Base URL
https://sandbox.pismolabs.io/lending
URL
https://sandbox.pismolabs.io/lending/v2/repayment-hierarchies
Auth
HTTP bearer

Headers

Idempotency-Keystring uuid required

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

Request body

hierarchystring[] required

List that defines the repayment priority order using the order items are listed. Determines which loan components are paid first during repayment processing. All seven items are required.

hierarchy_codestring required

Repayment hierarchy code. Must be unique and can contain alphanumeric characters, hyphens, and underscores.

Example request

{
  "hierarchy": [
    "PRINCIPAL",
    "INTEREST",
    "TAX",
    "FEE",
    "CHARGE",
    "PENALTY",
    "INSURANCE"
  ],
  "hierarchy_code": "CR008"
}

Response

Repayment hierarchy created successfully.

hierarchy_codestring required

Repayment hierarchy code

Example response

{
  "hierarchy_code": "CR008"
}

Changes

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