Export Payouts

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.

Export payouts to CSV format.

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

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
status OPTIONAL	string-	Filter by status
currency OPTIONAL	string-	Filter by currency
payoutType OPTIONAL	string-	Filter by payout type (IMPS, NEFT, RTGS, UPI)
fromDate OPTIONAL	string-	Start date (ISO 8601)
toDate OPTIONAL	string-	End date (ISO 8601)

Response

Success (200 OK)

Returns a CSV file download or a download URL:

{
  "success": true,
  "data": {
    "downloadUrl": "https://exports.zenpays.com/payouts/exp_xxxxx.csv",
    "expiresAt": "2024-01-15T11:30:00.000Z",
    "recordCount": 1250
  }
}

Examples

cURL

curl -X GET "https://api.zenpays.com/merchant/api/v1/payouts/export?status=succeeded&fromDate=2024-01-01" \
  -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 exportResult = await zenpays.payouts.export({
  status: 'succeeded',
  fromDate: '2024-01-01',
});

console.log(`Download: ${exportResult.downloadUrl}`);