Skip to main content
GET
/
api
/
canary
/
balance
Get Merchant Balance
curl --request GET \
  --url https://api.cashful.africa/api/canary/balance \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
merchantId
string

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

Response

Successfully retrieved merchant balance

​
id
string
required

Unique identifier

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
merchantId
string
required
​
amount
number
required
​
currency
string
required
​
available
number
required
​
pending
number
required
​
deletedAt
string<date-time>