<!-- ZenPays documentation · https://docs.zenpays.com/docs/rest-api/endpoints/wallet/get-balances -->

# Get Wallet Balances

Retrieve all wallet balances across currencies.

<EndpointHeader verb="GET" path="/merchant/api/v1/wallet/balances" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "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

<ParamTable
  rows={[
    { name: "availableBalance", type: "number", desc: "Funds available for withdrawal/payout" },
    { name: "totalBalance", type: "number", desc: "Total balance including all holds" },
    { name: "blockedBalance", type: "number", desc: "Funds blocked for disputes/reserves" },
    { name: "pendingBalance", type: "number", desc: "Funds being processed (incoming payments)" },
    { name: "lifetimeBalance", type: "number", desc: "Total funds ever received" },
    { name: "lifetimeWithdrawn", type: "number", desc: "Total funds ever withdrawn" },
    { name: "currency", type: "string", desc: "ISO 4217 currency code" },
    { name: "lastUpdated", type: "string", desc: "ISO 8601 timestamp of last balance update" },
    { name: "status", type: "string", desc: "Wallet status" },
    { name: "settlementFrequency", type: "string", desc: "Auto-settlement frequency" },
  ]}
/>

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
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"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

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

  </TabItem>
</Tabs>

</CodeRail>
