Repayment hierarchy

Get repayment hierarchy

Get a repayment hierarchy by its code, including the hierarchy order and current status.

get/v2/repayment-hierarchies/{hierarchyCode}

Request

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

Path parameters

hierarchyCodestring required

Repayment hierarchy code

Response

Repayment hierarchy retrieved successfully.

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.

status'ENABLED' | 'DISABLED' | 'DELETED' required

Repayment hierarchy status

Example response

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

Changes

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