Preview Loan Reschedule

Returns the repayment schedule the loan would have if the request were approved. Nothing is changed.

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
`requestId`	integer	TRUE	Id of the reschedule request.

Query Parameters

Field Name	Type	Required	Description
`clientId`	integer	FALSE	The customer's client id. Send exactly one of `clientId` or `nuban`.
`nuban`	string	FALSE	NUBAN of one of the customer's savings accounts. Send exactly one of `clientId` or `nuban`.

Response Body

Field Name	Type	Description
`periods`	array	One entry per installment.
`totalPrincipalExpected`	number	Principal to be repaid.

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

Responses

🟢200Schedule

application/json

Schedule

Bodyapplication/json

Example

{
  "currency": {
    "code": "NGN",
    "decimalPlaces": 2
  },
  "loanTermInDays": 273,
  "totalPrincipalExpected": 50000,
  "periods": [
    {
      "period": 1,
      "dueDate": [
        2026,
        12,
        10
      ],
      "principalDue": 5555.56
    }
  ]
}

🟠400The request could not be processed

🟠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

Path Parameters

Query Parameters

Response Body

Request

Request Code Samples

Responses

Preview Loan Reschedule

Path Parameters#

Query Parameters#

Response Body#

Request

Request Code Samples

Responses

Path Parameters

Query Parameters

Response Body