Redeem a voucher code

Validates and redeems a voucher code within the authenticated user's campaign. On success, increments the redemption counter and publishes a voucher.VoucherRedeemed event for downstream discount processing.

The voucher itself carries no discount value — the campaign's discount type configuration determines what action the redemption triggers.

Some campaign types require a partner credential supplied via the X-User-Token header; when the campaign demands one and it is missing or rejected, the redemption fails with HTTP 401 before the voucher counter is decremented.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Submits a voucher code for redemption within the authenticated campaign.

string
required
length ≥ 1

The voucher code to redeem.

Headers
uuid
required

Campaign scope for this request. Filters content to the specified campaign.

string

Partner-issued user session token. Required for campaigns whose discount type triggers a synchronous side-effect on a partner system (e.g. Carrefour loyalty event). The token is short-lived (≤5 minutes); requests received after expiry return 401.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json