Skip to main content
POST
Create vouchers in a batch

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

voucherSetId
integer<uint64>
required

Numeric id (voucherSetId). 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

Create vouchers in one transaction.

vouchers
object[]
required

1-1,000 vouchers; all-or-nothing.

Required array length: 1 - 1000 elements
defaults
object

Values for fields an item or row leaves empty.

Response

Success.

Single-object envelope around VoucherBatchResult.

data
object
required

Result of a batch create.