<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/payout-intents/list-payout-intents -->

# List Payout Intents

List payout intents with optional filters and pagination.

<EndpointHeader verb="GET" path="/payment/api/v1/payout-intents" />

## 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: "status", type: "string", desc: "Filter by status" },
    { name: "page", type: "number", desc: "Page number (default: 1)" },
    { name: "limit", type: "number", desc: "Items per page (default: 20)" },
    { name: "fromDate", type: "string", desc: "Start date (ISO format)" },
    { name: "toDate", type: "string", desc: "End date (ISO format)" },
  ]}
/>

## Response

### Success (200 OK)

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

<CodeRail>

## Examples

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

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

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

```javascript
const { data, total } = await zenpays.payouts.listPayoutIntents({
  status: 'succeeded',
  limit: 10,
})
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Create Payout Intent](/docs/rest-api/endpoints/payout-intents/create-payout-intent)
- [Get Payout Intent](/docs/rest-api/endpoints/payout-intents/get-payout-intent)
