Get Payout Statistics

Deprecated — Do Not Use

This endpoint is deprecated and will be removed in a future release. It is no longer maintained and may produce unexpected behavior.

Use Payout Intents instead.

Retrieve payout statistics and metrics.

GEThttps://api.zenpays.com/merchant/api/v1/payouts/stats

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

Query Parameters

Parameter	Type	Description
fromDate OPTIONAL	string30 days ago	Start date (ISO 8601)
toDate OPTIONAL	stringnow	End date (ISO 8601)
currency OPTIONAL	string-	Filter by currency

Response

Success (200 OK)

{
  "success": true,
  "data": {
    "totalPayouts": 1250,
    "totalVolume": 15000000,
    "totalFees": 31250,
    "successRate": 98.5,
    "averageAmount": 12000,
    "byStatus": {
      "succeeded": 1231,
      "failed": 15,
      "pending": 4
    },
    "byType": {
      "IMPS": 850,
      "NEFT": 300,
      "UPI": 100
    },
    "averageProcessingTime": "45 seconds"
  }
}

Examples

cURL

curl -X GET "https://api.zenpays.com/merchant/api/v1/payouts/stats?currency=INR" \
  -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 stats = await zenpays.payouts.getStats({ currency: 'INR' });
console.log(`Success rate: ${stats.successRate}%`);