List 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.

Retrieve a paginated list of payouts with optional filters.

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

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
page OPTIONAL	integer1	Page number
limit OPTIONAL	integer20	Items per page (max 100)
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)
minAmount OPTIONAL	number-	Minimum amount
maxAmount OPTIONAL	number-	Maximum amount
customerId OPTIONAL	string-	Filter by customer

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": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Examples

cURL

curl -X GET "https://api.zenpays.com/merchant/api/v1/payouts?status=succeeded&limit=50" \
  -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 { data, pagination } = await zenpays.payouts.list({
  status: 'succeeded',
  limit: 50,
});