Balance Inquiry

GET

/account/balance/{accountID}

This API retrieves the current balance information for a specific account.

Field Name	Data Type	Required	Description
accountID	string	true	The unique identifier of the account for which the balance is inquired.

The response is a JSON object containing the following fields:

Field Name	Data Type	Description
name	string	The name or description of the account.
balance	number	The current available balance of the account.
blockedAmount	number	The amount that is currently blocked or on hold in the account.
bvn	string	The Bank Verification Number (BVN) associated with the account.
accountID	string	The unique identifier of the account.

Request

Path Params

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

🟢200Balance Inquiry

application/json

Body

Example

{
    "name": "Kubwa POS Agents SubLedger",
    "balance": 0,
    "blockedAmount": 0,
    "bvn": "121212111",
    "accountID": "1234567"
}

Modified at 2025-03-17 22:07:31