Skip to main content
GET
/
api
/
canary
/
balance
Retrieves the merchant’s own master balance (their earnings) available for payouts.

​
Query Parameters

​
merchantId
string
The ID of the merchant whose balance is being requested. If omitted, defaults to the authenticated merchant.

​
Response

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

​
Example Response

{
  "id": "balance_merchant_456",
  "merchantId": "merchant_456",
  "amount": 50000,
  "currency": "ZAR",
  "available": 50000,
  "pending": 0,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.