Loan Pre-Closure Template

Returns the amount that closes the loan on a date. It changes nothing: to close the loan, post that amount with Enter Loan Repayment.

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.

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`.
`transactionDate`	string	FALSE	Date to close the loan on, in the format given by `dateFormat`. Defaults to today.
`dateFormat`	string	FALSE	Format of `transactionDate`, for example `dd MMMM yyyy`.
`locale`	string	FALSE	Language for the date, for example `en`.

Response Body

Field Name	Type	Description
`amount`	number	Total that closes the loan on the date.
`principalPortion`	number	Principal part.
`interestPortion`	number	Interest part.
`feeChargesPortion`	number	Fees part.
`penaltyChargesPortion`	number	Penalties part.
`date`	array	The date as [year, month, day].

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Pre-closure amount

application/json

Pre-closure amount

Bodyapplication/json

Example

{
  "type": {
    "id": 2,
    "code": "loanTransactionType.repayment",
    "value": "Repayment"
  },
  "date": [
    2026,
    11,
    6
  ],
  "amount": 41500,
  "principalPortion": 40000,
  "interestPortion": 1500,
  "feeChargesPortion": 0,
  "penaltyChargesPortion": 0
}

🟠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

Path Parameters

Query Parameters

Response Body