List Customer's Loans

Lists the loans of one customer: the holder of the savings account nuban, or the customer clientId. Each loan is identified by its loanAccountNo.

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

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
`loanAccountNo`	string	Account number of the loan.
`parentLoanAccountNo`	string	Account number of the group loan this loan belongs to, if any.
`id`	integer	Internal loan id.
`externalId`	string	Your own reference for the loan.
`productName`	string	Loan product.
`status`	object	Loan status.
`inArrears`	boolean	Whether the loan is overdue.
`originalLoan`	number	Amount of the loan.
`loanBalance`	number	Amount still owed.
`amountPaid`	number	Amount paid so far.

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

🟢200The customer's loans (an empty list when there are none)

application/json

The customer's loans (an empty list when there are none)

Bodyapplication/json

Example

[
  {
    "id": 7,
    "loanAccountNo": "000000059",
    "externalId": "LN-2026-0001",
    "productId": 1,
    "productName": "Micro Loan",
    "status": {
      "id": 300,
      "code": "loanStatusType.active",
      "value": "Active"
    },
    "inArrears": false,
    "originalLoan": 50000,
    "loanBalance": 41000,
    "amountPaid": 9000
  }
]

🟠400The request could not be processed

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

🟠403Your API user does not have permission for this operation

🟠404Not found

🔴500The request could not be completed

Query Parameters

Response Body

Request

Request Code Samples

Responses

List Customer's Loans

Query Parameters#

Response Body#

Request

Request Code Samples

Responses

Query Parameters

Response Body