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

# Settlement Statistics

Get settlement statistics and summary.

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

## 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" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "totalSettlements": 150,
    "totalSettled": 5000000,
    "pendingAmount": 250000,
    "byStatus": {
      "COMPLETED": 140,
      "PENDING": 8,
      "PROCESSING": 2,
      "FAILED": 0,
      "CANCELLED": 0
    },
    "averageSettlementTime": "1.5 days",
    "lastSettlement": {
      "settlementId": "stl_xxxxx",
      "amount": 100000,
      "status": "COMPLETED",
      "createdAt": "2024-01-17T10:00:00.000Z"
    }
  }
}
```

<CodeRail>

## Examples

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

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/stats/summary" \
  -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 stats = await zenpays.settlements.getStats();
```

  </TabItem>
</Tabs>

</CodeRail>
