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

# List Settlements

Retrieve a paginated list of settlements.

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

## 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" },
    { name: "startDate", type: "string", default: "-", desc: "Start date filter (ISO 8601)" },
    { name: "endDate", type: "string", default: "-", desc: "End date filter (ISO 8601)" },
    { name: "status", type: "string", default: "-", desc: "Filter by status (`PENDING`, `PROCESSING`, `COMPLETED`, `FAILED`, `CANCELLED`)" },
    { name: "type", type: "string", default: "-", desc: "Filter by settlement type" },
    { name: "priority", type: "string", default: "-", desc: "Filter by priority" },
    { name: "bankAccountId", type: "string", default: "-", desc: "Filter by bank account" },
    { name: "minAmount", type: "number", default: "-", desc: "Minimum settlement amount" },
    { name: "maxAmount", type: "number", default: "-", desc: "Maximum settlement amount" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": [
    {
      "settlementId": "stl_xxxxx",
      "merchantId": "mer_xxxxx",
      "amount": 100000,
      "settlementFee": 500,
      "netAmount": 99500,
      "currency": "USD",
      "type": "standard",
      "priority": "normal",
      "status": "COMPLETED",
      "description": "Monthly settlement",
      "bankAccountId": "ba_xxxxx",
      "scheduledDate": null,
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3
  }
}
```

<CodeRail>

## Examples

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

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/list?status=COMPLETED&minAmount=50000" \
  -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 } = await zenpays.settlements.list({
  status: 'COMPLETED',
  minAmount: 50000,
});
```

  </TabItem>
</Tabs>

</CodeRail>
