Void Authorization
POST
/v1/payments/{id}/voidRecommendedRelease an uncaptured authorization. No ledger entries are posted (no money moved on Kvell's books). Idempotent against an already-voided row.
Authentication
Signature Pattern
HMAC-SHA256(secretKey, "{timestamp}\nPOST\n/v1/payments/{id}/void\n{sha256(body)}")| Header | Value | Description |
|---|---|---|
X-Api-Key | pk_live_a1b2c3d4e5f6g7h8 | Merchant public API key |
X-Signature | {hmac_sha256_hex} | Hex HMAC-SHA256 request signature (see below) |
X-Timestamp | 2026-04-13T10:00:00Z | ISO 8601 UTC request time, validated within ±5 min |
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
reason | string | Optional | Free text (≤500 chars), surfaced on the payment.voided event |
Request Example
JSONRequest Body
{
"reason": "Order abandoned"
}Response Parameters
| Field | Type | Example |
|---|---|---|
id | string | "pay_1a2b3c4d5e6f" |
status | string | "voided" |
amount | integer | 15000 |
currency | string | "TRY" |
Response Example
JSONResponse
{
"id": "pay_1a2b3c4d5e6f",
"status": "voided",
"amount": 15000,
"currency": "TRY"
}Status Codes
200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
Try itMock
POSThttps://api.pay.sandbox.kvell.group