These docs are for v1.0. Click to read the latest docs for v2.1.

Create a redemption

post

https://preview.vouchery.io/api/v1.0/vouchers/{code}/redemptions

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code

string

required

Voucher code

Body Params

transaction_id

string

required

Unique transaction ID which identifies underlying transaction in your system, e.g. order number, invoice number

customer_identifier

string

A string uniquely identifying customer in your system, e.g. an ID, uuid, email address

total_transaction_cost

number

required

user_agent

string | null

location

object | null

This parameter is just for convenience and will not be stored. Vouchery will try to map the string to a position, which will be stored in the position property.

categories

array of objects

One or multiple key value pairs, where the key is the category name, and the value is a tag

categories

confirmed

boolean

required

Only confirmed redemption are counted towards budget and total number of redemptions.
As long as a redemption is not confirmed, the budget might be used up by other redemptions
in the mean time. In that case, accepting the redemption (by updating it) will fail.
The same applies for number of redemptions, and budget per day/week/month/year.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json