v1
latestOpenAPI 3.0.32026-07-2246176.0 KBAPI ordering
Read wallet balance
Returns the authenticated caller's wallet balance and currency. Authenticate with the api-token header. The email is derived server-side from the auth identity, so a token can only ever read its own wallet (IDOR-safe).
By default this is an O(1) wallet primary-key lookup (balance + currency only). Pass include_counts=1 to also return topups_count and purchases_count (email-scoped compound indexes on orders).
Gated on account:api_ordering:read for API keys (admin-grant-only; off by default).
get/v4/account/orders/balance
Query parameters
include_countsboolean
When true, include topups_count and purchases_count in the response. Omit for the lightweight balance-only read used by checkout.
Response
Wallet balance (and optional activity counts).
Example response
{
"success": true,
"data": {
"balance": 42.5,
"currency": "USD",
"topups_count": 8,
"purchases_count": 30
}
}