Get Account Details

This API fetches detailed account information for a specific client, including account type, balance, status, and other relevant data.

Path Parameter

Field Name	Type	Required	Description
nuban	string	true	NUBAN refers to the client's account number.

Response Table

Field Name	Type	Description
id	integer	Unique identifier of the account.
firstname	string	First name of the account holder.
lastname	string	Last name of the account holder.
nuban	string	Generated NUBAN (bank account number).
currentBalance	float	Current balance in the account.
availableBalance	float	Available balance in the account.
accountName	string	Full name of the account holder.
productName	string	Name of the product associated with the account.
productShortName	string	Unique abbreviation of the product name.
productCurrency	string	Currency denomination of the account.
coreBankingId	integer	Unique identifier in the core banking system.
postNoDebit	boolean	Indicates whether a post no debit has been placed on an account
blockStatus	boolean	Indicates whether a block has been placed on an account
reasonForBlock	boolean	Reason for a block or post no debit

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

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "id": 1,
  "firstname": "Sample",
  "lastname": "Customer",
  "nuban": "0000000017",
  "currentBalance": 48051,
  "availableBalance": 42051,
  "accountName": "Sample Customer 4",
  "productName": "Sample Organisation 9",
  "productShortName": "Sample Organisation 13",
  "productCurrency": "NGN",
  "coreBankingId": 1,
  "postNoDebit": true,
  "blockStatus": false,
  "reasonForBlock": "PND"
}

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Path Parameter

Response Table

Request

Request Code Samples

Responses

Get Account Details

Path Parameter#

Response Table#

Request

Request Code Samples

Responses

Path Parameter

Response Table