GET
/
accounts
/
{account_number}
/
balances
{
  "status": "00",
  "message": "The process was completed successfully",
  "data": {
    "account_number": "0123456789",
    "currency": "NGN",
    "available_balance": 8000,
    "cleared_balance": 1000000,
    "uncleared_balance": 0,
    "hold_balance": 1000,
    "minimum_balance": 100000,
    "custom_properties": [
      {
        "id": "1",
        "description": "custom_property",
        "type": "string",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Path Parameters

​
account_number
string
required

Customer's account number in NUBAN format

Response

Successfully retrieved account balances

​
status
string
required
Example:

"00"

​
message
string
required
Example:

"The process was completed successfully"

​
data
object
required
⌘I