Get Wallet Balances

Retrieve all wallet balances across currencies.

GEThttps://api.zenpays.com/merchant/api/v1/wallet/balances

Bearer · API key

Request

Headers

Header	Description
Authorization REQUIRED	Bearer {api_key}
X-Signature REQUIRED	HMAC-SHA256 signature
X-Timestamp REQUIRED	ISO 8601 timestamp
X-Secret-Salt REQUIRED	Secret salt for HMAC validation

Response

Success (200 OK)

{
  "success": true,
  "data": [
    {
      "currency": "USD",
      "availableBalance": 250000,
      "totalBalance": 270000,
      "blockedBalance": 5000,
      "pendingBalance": 15000,
      "lifetimeBalance": 1500000,
      "lifetimeWithdrawn": 1230000,
      "lastUpdated": "2024-01-15T10:30:00.000Z",
      "status": "ACTIVE",
      "settlementFrequency": "daily"
    },
    {
      "currency": "INR",
      "availableBalance": 5000000,
      "totalBalance": 5350000,
      "blockedBalance": 100000,
      "pendingBalance": 250000,
      "lifetimeBalance": 25000000,
      "lifetimeWithdrawn": 19650000,
      "lastUpdated": "2024-01-15T10:30:00.000Z",
      "status": "ACTIVE",
      "settlementFrequency": "weekly"
    }
  ]
}

Balance Fields

Parameter	Type	Description
availableBalance OPTIONAL	number	Funds available for withdrawal/payout
totalBalance OPTIONAL	number	Total balance including all holds
blockedBalance OPTIONAL	number	Funds blocked for disputes/reserves
pendingBalance OPTIONAL	number	Funds being processed (incoming payments)
lifetimeBalance OPTIONAL	number	Total funds ever received
lifetimeWithdrawn OPTIONAL	number	Total funds ever withdrawn
currency OPTIONAL	string	ISO 4217 currency code
lastUpdated OPTIONAL	string	ISO 8601 timestamp of last balance update
status OPTIONAL	string	Wallet status
settlementFrequency OPTIONAL	string	Auto-settlement frequency

Examples

cURL

curl -X GET "https://api.zenpays.com/merchant/api/v1/wallet/balances" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"

SDK

const balances = await zenpays.wallet.getBalances();
balances.forEach(b => {
  console.log(`${b.currency}: ${b.availableBalance} available`);
});