H!HOPPA
POST/api/v2/users/{userId}/referrals/vouchers/{assignmentId}/redeem

Redeems an assigned voucher without exposing or typing its voucher code.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)integer (int32)Yes
assignmentId (path)string (uuid)Yes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
VoucherIdstring (uuid)Yes
VoucherNamestringYes
AmountunknownYes
CurrencystringYes
StatusstringYes
TransactionReferencestringYes
ErrorCodestringYes
CreatedAtstring (date-time)Yes
CompletedAtstring (date-time)Yes

Example request

curl -X POST "https://{base_url}/api/v2/users/{userId}/referrals/vouchers/{assignmentId}/redeem" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.