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

# Cancel Settlement

Cancel a pending settlement request.

<EndpointHeader verb="PUT" path="/merchant/api/v1/settlements/{id}/cancel" />

## Request

### Path Parameters

<ParamTable
  rows={[
    { name: "id", type: "string", required: true, desc: "Settlement ID" },
  ]}
/>

### 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": {
    "settlementId": "stl_xxxxx",
    "status": "CANCELLED",
    "message": "Settlement cancelled successfully"
  }
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "SETTLEMENT_NOT_CANCELLABLE", status: "400", message: "Settlement cannot be cancelled (not in `PENDING` status)" },
    { code: "SETTLEMENT_NOT_FOUND", status: "404", message: "Settlement doesn't exist" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X PUT "https://api.zenpayz.com/merchant/api/v1/settlements/stl_xxxxx/cancel" \
  -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
await zenpays.settlements.cancel('stl_xxxxx');
```

  </TabItem>
</Tabs>

</CodeRail>
