Skip to main content
GET
/
api
/
canary
/
customers
/
{id}
/
balance
Retrieves the real-time balance for a single customer’s “cash balance” (the “wallet-enabling” feature).

​
Path Parameters

​
id
string
required
The unique identifier of the customer

​
Response

​
Success
​
id
string
Unique identifier for the balance record
​
customerId
string
The customer’s unique identifier
​
amount
number
Total cash balance amount
​
currency
string
The currency code
​
available
number
Amount available for immediate use
​
pending
number
Amount pending from recent transactions
​
createdAt
string
ISO 8601 timestamp when the balance was created
​
updatedAt
string
ISO 8601 timestamp when the balance was last updated

​
Example Response

{
  "id": "balance_001",
  "customerId": "customer_789",
  "amount": 5000,
  "currency": "ZAR",
  "available": 5000,
  "pending": 0,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Not Found
Customer not found
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.