Skip to main content
POST
Redeem a voucher

Authorizations

Authorization
string
header
required

Bearer token created in the GVB API Access page.

Headers

Accept
enum<string>
required

Must be application/json.

Available options:
application/json

Path Parameters

tenant
integer
required

Authorised tenant identifier from the tenant directory.

Body

application/json

Use the short-lived token returned by resolve, or an authorised voucher id. Amount is in major units.

redemption_token
string
required
voucher_id
integer | null
Required range: x >= 1
amount
number | null

Optional partial redemption amount in major currency units.

Response

Successful response.

data
RedemptionResult · object
required