Admin — redeem a voucher code on behalf of a user

Validates and redeems a voucher code on behalf of the supplied external_user_id. Campaign is derived from the S2SJWT token. On success, publishes a voucher.VoucherRedeemed event with the user identity so downstream discount listeners can attribute the redemption.

For campaigns whose discount type triggers a synchronous side-effect on a partner system (e.g. Carrefour loyalty event), the operator must supply the user's partner credential via the X-User-Token header. Without it, redemptions on those campaigns fail 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

Redeem a voucher code on behalf of a user (S2S).

string
required
length ≥ 1
string
required

The external user redeeming the voucher.

Headers
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
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json