Get Wallet Summary
Get a summary of wallet activity and balances. Additional endpoints are available for monthly analytics and a simplified balance view.
Wallet Summary
GET
https://api.zenpays.com/merchant/api/v1/wallet/summaryBearer · API key
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 (200 OK)
{
"success": true,
"data": {
"totalBalance": {
"USD": 270000,
"INR": 5350000,
"EUR": 80000
},
"todayActivity": {
"credits": 25000,
"debits": 10000,
"netChange": 15000
},
"thisMonth": {
"totalCredits": 500000,
"totalDebits": 350000,
"netChange": 150000
},
"pendingSettlements": 2,
"pendingPayouts": 5,
"lastActivity": "2024-01-15T10:30:00.000Z"
}
}
Monthly Analytics
GET
https://api.zenpays.com/merchant/api/v1/wallet/analytics/monthlyBearer · API key
Retrieve monthly wallet analytics and trends.
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 |
Simple Balance
GET
https://api.zenpays.com/merchant/api/v1/wallet/balance/simpleBearer · API key
Retrieve a simplified view of wallet balances.
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 |
Examples
- cURL
- SDK
# Get wallet summary
curl -X GET "https://api.zenpays.com/merchant/api/v1/wallet/summary" \
-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"
# Get monthly analytics
curl -X GET "https://api.zenpays.com/merchant/api/v1/wallet/analytics/monthly" \
-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"
# Get simple balance
curl -X GET "https://api.zenpays.com/merchant/api/v1/wallet/balance/simple" \
-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"
const summary = await zenpays.wallet.getSummary();
console.log(`Today's net: ${summary.todayActivity.netChange}`);
const analytics = await zenpays.wallet.getMonthlyAnalytics();
const simpleBalance = await zenpays.wallet.getSimpleBalance();