Retrieve Loan

Returns one loan. associations adds related data, for example repaymentSchedule,transactions.

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`.
`associations`	string	FALSE	Comma-separated extra data to include, for example `repaymentSchedule,transactions`, or `all`.
`exclude`	string	FALSE	Comma-separated data to leave out.
`fields`	string	FALSE	Comma-separated fields to return.

Response Body

Field Name	Type	Description
`loanAccountNo`	string	Account number of the loan.
`id`	integer	Internal loan id.
`externalId`	string	Your own reference for the loan.
`status`	object	Loan status.
`clientId`	integer	Customer the loan belongs to.
`clientName`	string	Customer name.
`clientAccountNo`	string	The customer's own account number.
`loanProductName`	string	Loan product.
`principal`	number	Amount of the loan.
`linkedAccount.nuban`	string	NUBAN of the savings account the loan is paid out to, when there is one.

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

🟢200The loan

application/json

The loan

Bodyapplication/json

Example

{
  "id": 7,
  "loanAccountNo": "000000059",
  "externalId": "LN-2026-0001",
  "status": {
    "id": 300,
    "code": "loanStatusType.active",
    "value": "Active"
  },
  "clientId": 42,
  "clientName": "Ada Obi",
  "clientAccountNo": "000000042",
  "loanProductId": 1,
  "loanProductName": "Micro Loan",
  "principal": 50000,
  "linkedAccount": {
    "id": 12,
    "nuban": "0000000206",
    "clientId": 42,
    "clientName": "Ada Obi",
    "productName": "Savings"
  }
}

🟠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