Get Payout Intent
Retrieve the current status and details of a payout intent.
GET
https://api.zenpayz.com/payment/api/v1/payout-intents/{intentId}Bearer · API key
Request
Path Parameters
| Parameter | Type | Description |
|---|---|---|
intentId REQUIRED | string | Payout intent 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 |
Response
Success (200 OK)
{
"success": true,
"data": {
"intentId": "poi_xxxxx",
"status": "succeeded",
"amount": 10000,
"currency": "INR",
"beneficiaryName": "John Doe",
"payoutId": "payout_xxxxx",
"processingFee": 25,
"totalDebitedAmount": 10025,
"expiresAt": "2024-01-15T11:00:00.000Z",
"confirmedAt": "2024-01-15T10:35:00.000Z",
"completedAt": "2024-01-15T10:36:00.000Z",
"createdAt": "2024-01-15T10:30:00.000Z"
}
}
Examples
- cURL
- SDK
curl "https://api.zenpayz.com/payment/api/v1/payout-intents/poi_xxxxx" \
-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 intent = await zenpays.payouts.getPayoutIntent('poi_xxxxx')
console.log(intent.status) // 'succeeded'
Intent Statuses
| Status | Description |
|---|---|
requires_confirmation | Waiting for required fields to be submitted |
processing | Payout is being processed |
succeeded | Payout completed successfully |
failed | Payout failed (see failureReason) |
cancelled | Cancelled before confirmation |
expired | Not confirmed within 30 minutes |