Balance
Get current balance
Returns the calling account’s current balance grouped by scope and currency. Each balance has 6 buckets (available, pending, reserved, payable, collateral, operational) representing the lifecycle of funds. Use the optional scopeLevel / scopeEntityId query params to narrow to a specific entity (e.g. one merchant when called from a tenant-level key).
Authorization
bearer AuthorizationBearer <token>
In: header
Query Parameters
scopeLevel?string
Restrict to balances at a specific scope level (e.g. only merchant-scoped).
Value in
"terminal" | "channel" | "merchant" | "company" | "tenant" | "platform" | "partner" | "funding_account"scopeEntityId?string
Restrict to a specific entity ID (UUID v7). Must be paired with scopeLevel.
Format
uuidcurrency?string
Restrict to a single ISO 4217 currency code (e.g. USD, EUR).
Response Body
application/json
curl -X GET "https://<api-host>/v1/balance"{
"data": [
{
"currency": "string",
"buckets": [
{
"type": "available",
"amount": {
"currency": "string",
"valueMinor": 9007199254740991
}
}
],
"updatedAt": "string",
"scope": {
"level": "terminal",
"terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659"
}
}
],
"pagination": {
"nextCursor": "string",
"prevCursor": "string",
"hasMore": true,
"totalCount": 0
}
}Empty
Empty