Calculate Loan Schedule with Term Variations

Works out the repayment schedule with the given term variations applied, without saving them.

The customer is named with exactly one of clientId or nuban (the number of one of the customer's savings accounts). The loan must belong to that customer, otherwise the request is refused with 403.

Path Parameters

Field Name	Type	Required	Description
`loanAccountNo`	string	TRUE	The loan's account number, as returned when the loan was created.

Request Body

Field Name	Type	Required	Description
`clientId`	integer	FALSE	The customer's client id. Required if `nuban` is not sent.
`nuban`	string	FALSE	NUBAN of one of the customer's savings accounts. Required if `clientId` is not sent.
`exceptions`	object	TRUE	The variations, for example `modifiedinstallments`: installments whose due date or amount changes.
`dateFormat`	string	FALSE	Format of the dates. Defaults to `yyyy-MM-dd`.
`locale`	string	FALSE	Defaults to `en`.

Response Body

Field Name	Type	Description
`periods`	array	One entry per installment, with the variations applied.
`totalPrincipalExpected`	number	Principal to be repaid.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Path Params

Body Params application/json

Example

{
  "clientId": 42,
  "dateFormat": "yyyy-MM-dd",
  "locale": "en",
  "exceptions": {
    "modifiedinstallments": [
      {
        "dueDate": "2026-12-10",
        "modifiedDueDate": "2026-12-20"
      }
    ]
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Schedule

application/json

Schedule

Bodyapplication/json

Example

{
  "currency": {
    "code": "NGN",
    "decimalPlaces": 2
  },
  "loanTermInDays": 191,
  "totalPrincipalExpected": 50000,
  "periods": [
    {
      "period": 1,
      "dueDate": [
        2026,
        12,
        20
      ],
      "principalDue": 8000
    }
  ]
}

🟠400Validation failed

🟠401The merchant's account has not been granted this operation,

🟠403The loan is not the customer's, or your API user does not ha

🟠404Not found

🔴500The request could not be completed