Cancel Settlement

Cancel a pending settlement request.

PUThttps://api.zenpayz.com/merchant/api/v1/settlements/{id}/cancel

Bearer · API key

Request

Path Parameters

Parameter	Type	Description
id REQUIRED	string	Settlement ID

Headers

Header	Description
Authorization REQUIRED	Bearer {api_key}
X-Signature REQUIRED	HMAC-SHA256 signature
X-Timestamp REQUIRED	ISO 8601 timestamp
X-Secret-Salt REQUIRED	Secret salt for HMAC validation

Response

Success (200 OK)

{
  "success": true,
  "data": {
    "settlementId": "stl_xxxxx",
    "status": "CANCELLED",
    "message": "Settlement cancelled successfully"
  }
}

Error Responses

Code	HTTP	Message
SETTLEMENT_NOT_CANCELLABLE	400	Settlement cannot be cancelled (not in PENDING status)
SETTLEMENT_NOT_FOUND	404	Settlement doesn't exist

Examples

cURL

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"

SDK

await zenpays.settlements.cancel('stl_xxxxx');