<!-- ZenPays documentation · https://docs.zenpays.com/docs/rest-api/endpoints/payouts/list-payouts -->

# List Payouts

:::danger[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](/docs/rest-api/endpoints/payout-intents/list-payout-intents) instead.**
:::

Retrieve a paginated list of payouts with optional filters.

<EndpointHeader verb="GET" path="/merchant/api/v1/payouts" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
  ]}
/>

### Query Parameters

<ParamTable
  rows={[
    { name: "page", type: "integer", default: "1", desc: "Page number" },
    { name: "limit", type: "integer", default: "20", desc: "Items per page (max 100)" },
    { name: "status", type: "string", default: "-", desc: "Filter by status" },
    { name: "currency", type: "string", default: "-", desc: "Filter by currency" },
    { name: "payoutType", type: "string", default: "-", desc: "Filter by payout type (`IMPS`, `NEFT`, `RTGS`, `UPI`)" },
    { name: "fromDate", type: "string", default: "-", desc: "Start date (ISO 8601)" },
    { name: "toDate", type: "string", default: "-", desc: "End date (ISO 8601)" },
    { name: "minAmount", type: "number", default: "-", desc: "Minimum amount" },
    { name: "maxAmount", type: "number", default: "-", desc: "Maximum amount" },
    { name: "customerId", type: "string", default: "-", desc: "Filter by customer" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "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
  }
}
```

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
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"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const { data, pagination } = await zenpays.payouts.list({
  status: 'succeeded',
  limit: 50,
});
```

  </TabItem>
</Tabs>

</CodeRail>
