List Payout Intents
List payout intents with optional filters and pagination.
GET
https://api.zenpayz.com/payment/api/v1/payout-intentsBearer · 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 |
page OPTIONAL | number | Page number (default: 1) |
limit OPTIONAL | number | Items per page (default: 20) |
fromDate OPTIONAL | string | Start date (ISO format) |
toDate OPTIONAL | string | End date (ISO format) |
Response
Success (200 OK)
{
"success": true,
"data": {
"data": [
{
"intentId": "poi_xxxxx",
"status": "succeeded",
"amount": 10000,
"currency": "INR",
"beneficiaryName": "John Doe",
"payoutId": "payout_xxxxx",
"createdAt": "2024-01-15T10:30:00.000Z"
}
],
"total": 25,
"page": 1,
"limit": 20,
"totalPages": 2,
"hasMore": true
}
}
Examples
- cURL
- SDK
curl "https://api.zenpayz.com/payment/api/v1/payout-intents?status=succeeded&limit=10" \
-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 { data, total } = await zenpays.payouts.listPayoutIntents({
status: 'succeeded',
limit: 10,
})