Calculate Loan Schedule

Works out the repayment schedule of a loan application without creating it. Takes the same body as Submit Loan Application. The loan is not saved.

The customer is named with exactly one of clientId or nuban (the number of one of the customer's savings accounts).

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.
`productId`	integer	TRUE	Loan product.
`principal`	number	TRUE	Amount applied for. Must be 0.01 or greater.
`loanTermFrequency`	integer	TRUE	Length of the loan, in units of `loanTermFrequencyType`.
`loanTermFrequencyType`	integer	TRUE	Unit of the loan term: 0 days, 1 weeks, 2 months, 3 years.
`numberOfRepayments`	integer	TRUE	Number of repayments.
`repaymentEvery`	integer	TRUE	Time between repayments, in units of `repaymentFrequencyType`.
`repaymentFrequencyType`	integer	TRUE	Unit between repayments: 0 days, 1 weeks, 2 months.
`expectedDisbursementDate`	string	TRUE	Format yyyy-MM-dd.
`interestRatePerPeriod`	number	FALSE	Interest rate per period.
`amortizationType`	integer	FALSE	0 equal principal payments, 1 equal installments.
`interestType`	integer	FALSE	0 declining balance, 1 flat.
`interestCalculationPeriodType`	integer	FALSE	0 daily, 1 same as the repayment period.
`transactionProcessingStrategyCode`	string	FALSE	How repayments are applied.
`submittedOnDate`	string	FALSE	Format yyyy-MM-dd. Defaults to today.
`loanType`	string	FALSE	Defaults to `individual`.
`externalId`	string	FALSE	Your own reference for the loan.

Response Body

Field Name	Type	Description
`currency`	object	Currency of the schedule.
`loanTermInDays`	integer	Length of the loan in days.
`totalPrincipalExpected`	number	Principal to be repaid.
`totalInterestCharged`	number	Interest to be charged.
`totalRepaymentExpected`	number	Total to be repaid.
`periods`	array	One entry per installment.

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

Body Params application/json

Example

{
  "nuban": "0000000206",
  "productId": 1,
  "principal": 50000,
  "loanTermFrequency": 6,
  "loanTermFrequencyType": 2,
  "numberOfRepayments": 6,
  "repaymentEvery": 1,
  "repaymentFrequencyType": 2,
  "interestRatePerPeriod": 2,
  "amortizationType": 1,
  "interestType": 0,
  "interestCalculationPeriodType": 1,
  "expectedDisbursementDate": "2026-11-10"
}

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": 181,
  "totalPrincipalExpected": 50000,
  "totalInterestCharged": 3150,
  "totalRepaymentExpected": 53150,
  "periods": [
    {
      "period": 1,
      "dueDate": [
        2026,
        12,
        10
      ],
      "principalDue": 8000,
      "interestDue": 1000,
      "totalDueForPeriod": 9000
    }
  ]
}

🟠400Validation failed

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

🟠404Not found

🔴500The request could not be completed

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body