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

HeaderTypeStatusDescription
AuthorizationstringRequiredBearer vxz_tok_* (OAuth 2.0 Scoped Bearer Token)

Balance Attributes

FieldTypeDescription
walletIdstringUnique ledger wallet identifier (e.g. wal_live_381048291048).
accountNumberstring13-digit account number starting with 38.
availableBalancenumberFunds immediately available for payout or withdrawal.
lockedBalancenumberFunds temporarily held in active P2P escrow vaults.
totalBalancenumberTotal 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"
}