Check Balance
Queries the single unified sovereign wallet for the authenticated business or account holder. Neither users nor businesses have multiple wallets; all transactions, pending escrow holds, and float reside in one unified purse.
GET/v1/wallet/balanceLive & Sandbox
Request Headers
| Header | Type | Status | Description |
|---|---|---|---|
Authorization | string | Required | Bearer vxz_tok_* (OAuth 2.0 Scoped Bearer Token) |
Balance Attributes
| Field | Type | Description |
|---|---|---|
walletId | string | Unique ledger wallet identifier (e.g. wal_live_381048291048). |
accountNumber | string | 13-digit account number starting with 38. |
availableBalance | number | Funds immediately available for payout or withdrawal. |
lockedBalance | number | Funds temporarily held in active P2P escrow vaults. |
totalBalance | number | Total balance: availableBalance + lockedBalance. |
Request Code Snippets (cURL, Node, Python, PHP, Go)
Request Example
curl -X GET https://developer.vixzz.com/v1/wallet/balance \
-H "Authorization: Bearer vxz_tok_c2b_8f9k3m9s2a1l"JSON Return Response Body (200 OK)
Response
{
"success": true,
"walletId": "wal_live_381048291048",
"accountNumber": "3810482910482",
"currency": "KES",
"availableBalance": 4850000,
"lockedBalance": 120000,
"totalBalance": 4970000,
"status": "ACTIVE",
"updatedAt": "2026-09-07T02:35:00.000Z"
}