Accounts

This API retrieves a list of savings accounts of a client by clientId. It provides details such as the account holder’s name, account number (NUBAN), balances, product type, and recent transaction activities.

Path Parameter

Field Name	Type	Required	Description
clientId	string	TRUE	The unique identifier of the account holder whose accounts are being retrieved.

Response

Field Name	Type	Description
id	integer	Unique identifier for the account
firstname	string	Account holder's first name
lastname	string	Account holder's last name
nuban	string	Unique account number (NUBAN)
currentBalance	float	Total balance including pending transactions
availableBalance	float	Balance available for withdrawal
productId	integer	Identifier for the account product type
subLedgerActivated	boolean	Indicates if the sub-ledger is activated
accountName	string	Full name of the account holder
productName	string	Name of the account product
coreBankingAccountId	integer	Core banking system identifier for the account
thisWeekCredits	float	Total credits received this week
thisWeekDebits	float	Total debits made this week
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": "1100000011",
    "currentBalance": 168283.3,
    "availableBalance": 168283.3,
    "productId": 101,
    "subLedgerActivated": false,
    "accountName": "Sample Customer 2",
    "productName": "Sample Organisation 2",
    "coreBankingAccountId": 1,
    "thisWeekCredits": 798097.5,
    "thisWeekDebits": 630529.01,
    "postNoDebit": false,
    "blockStatus": false
  },
  {
    "id": 16388,
    "firstname": "Sample",
    "lastname": "Customer",
    "nuban": "0000000147",
    "currentBalance": 100000,
    "availableBalance": 100000,
    "productId": 136,
    "subLedgerActivated": false,
    "accountName": "Sample Customer 2",
    "productName": "savingtest",
    "coreBankingAccountId": 16388,
    "thisWeekCredits": 100000,
    "thisWeekDebits": 0,
    "postNoDebit": true,
    "blockStatus": false,
    "reasonForBlock": "PND"
  }
]

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Path Parameter

Response

Request

Request Code Samples

Responses

Accounts

Path Parameter#

Response#

Request

Request Code Samples

Responses

Path Parameter

Response