Batch Payout Items
Retrieve individual payouts within a batch, with optional status filtering and pagination.
GET
https://api.zenpays.com/payment/api/v1/batch-payouts/{batchId}/payoutsBearer · API key
Request
Path Parameters
| Parameter | Type | Description |
|---|---|---|
batchId REQUIRED | string | Batch payout ID |
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 |
|---|---|---|
page OPTIONAL | number | Page number (default: 1) |
limit OPTIONAL | number | Items per page (default: 50) |
status OPTIONAL | string | Filter by payout status |
Response
Success (200 OK)
{
"success": true,
"data": {
"payouts": [
{
"payoutId": "payout_xxxxx",
"beneficiaryName": "Alice Smith",
"beneficiaryAccount": "1234567890",
"amount": 5000,
"currency": "INR",
"status": "completed",
"payoutType": "imps",
"tspProvider": "paytara",
"externalPayoutId": "ext_xxxxx",
"createdAt": "2024-01-15T10:30:00.000Z"
},
{
"payoutId": "payout_yyyyy",
"beneficiaryName": "Bob Johnson",
"beneficiaryVpa": "bob@upi",
"amount": 3000,
"currency": "INR",
"status": "failed",
"payoutType": "upi",
"failureReason": "Invalid VPA",
"createdAt": "2024-01-15T10:30:01.000Z"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 2,
"totalPages": 1,
"hasNext": false,
"hasPrev": false
}
}
}
Examples
- cURL
- SDK
curl "https://api.zenpays.com/payment/api/v1/batch-payouts/batch_xxxxx/payouts?status=failed" \
-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 all failed payouts in a batch
const { data } = await zenpays.payouts.getBatchPayouts('batch_xxxxx', {
status: 'failed',
})
data.forEach(payout => {
console.log(`${payout.payoutId}: ${payout.failureReason}`)
})