Get Payout

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 details of a specific payout by ID.

GEThttps://api.zenpays.com/merchant/api/v1/payouts/{payoutId}

Bearer · API key

Request

Path Parameters

Parameter	Type	Description
payoutId REQUIRED	string	Payout ID (e.g., pay_xxxxx)

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": {
    "payoutId": "pay_xxxxx",
    "merchantId": "mer_xxxxx",
    "amount": 10000,
    "currency": "INR",
    "status": "succeeded",
    "externalPayoutId": "pout_xxxxx",
    "processingFee": 25,
    "totalDebitedAmount": 10025,
    "estimatedCompletion": "2024-01-15T11:00:00.000Z",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "metadata": {}
  }
}

Error Responses

Code	HTTP	Message
UNAUTHORIZED	401	Invalid API key
PAYOUT_NOT_FOUND	404	Payout doesn't exist

Examples

cURL

curl -X GET "https://api.zenpays.com/merchant/api/v1/payouts/pay_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"

SDK

const payout = await zenpays.payouts.get('pay_xxxxx');
console.log(`Status: ${payout.status}`);