Skip to main content
GET
/
customer
/
account
/
balance
/
{account_id}
Get Client Account Balance Signed
curl --request GET \
  --url https://api.example.com/customer/account/balance/{account_id} \
  --header 'X-API-KEY: <x-api-key>' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --header 'X-API-TIMESTAMP: <x-api-timestamp>'
{
  "message": "<string>",
  "data": {
    "account_id": "4iIN-rdBXRDJXV--V5F-Co-",
    "account_number": "0000013",
    "available_balance": {
      "amount": 123,
      "currency": "<string>"
    },
    "held_balance": {
      "amount": 123,
      "currency": "<string>"
    },
    "total_balance": {
      "amount": 123,
      "currency": "<string>"
    },
    "system_timestamp": "2025-05-16T18:16:45.088469926Z"
  }
}
Retrieve the current balance information for a specific account. Returns detailed balance data including available balance, current balance, and any pending transactions.

Headers

​
X-API-SIGNATURE
string
required

Signature header

​
X-API-TIMESTAMP
integer
required

Timestamp header

​
X-API-NONCE
string
required

Nonce header

​
X-API-KEY
string
required

Account ID header

Path Parameters

​
account_id
string
required

Response

Successful Response

​
message
string
required
​
data
ClientAccountBalanceResponse · object

Schema to serialize the account balance response.