Skip to main content
POST
Revoke a voucher

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Path Parameters

voucherId
integer<uint64>
required

Numeric id (voucherId). A non-numeric id is a 400 data-failed-validation; an unknown id or one of another partner is a 404. Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

Revoke one voucher.

reason
string
required

1-500 characters.

Required string length: 1 - 500

Response

Success.

Single-object envelope around Voucher.

data
object
required

A voucher. The clear value is never part of this resource.