Cancel Payout
POST
/v1/payouts/{id}/cancelOptionalCancel a payout while it is still cancellable (created / pre-lock funds_locked). Posts the reverse ledger leg when needed.
Authentication
Signature Pattern
HMAC-SHA256(secretKey, "{timestamp}\nPOST\n/v1/payouts/{id}/cancel\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 |
X-Timestamp | 2026-04-13T10:00:00Z | ISO 8601 UTC request time (±5 min) |
Request Example
JSONRequest Body
{}Response Parameters
| Field | Type | Example |
|---|---|---|
payoutId | string | "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5" |
status | string | "cancelled" |
resolvedAt | string | "2026-04-13T10:00:02Z" |
Response Example
JSONResponse
{
"payoutId": "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5",
"status": "cancelled",
"resolvedAt": "2026-04-13T10:00:02Z"
}Status Codes
200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
Try itMock
POSThttps://api.pay.sandbox.kvell.group