LoyaltyReward

Create redeem voucher request

Creates a request to redeem a voucher.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID

Request

This endpoint expects an object.
attributedRewardIdstringOptionalformat: "uuid"
Unique identifier for the attributed reward
codestringOptional
Redemption code for the reward
contactIdlongOptional
Unique identifier for the contact
loyaltySubscriptionIdstringOptional
Identifier for the loyalty subscription
metamap from strings to anyOptional
Additional metadata associated with the redeem request
orderobjectOptional
Order details for the redemption
rewardIdstringOptionalformat: "uuid"
Unique identifier for the reward
ttlintegerOptional>=0
Time to live in seconds for the redemption request

Response

Redeem request successfully created
cancelledAtdatetime or null
Timestamp when the redemption was cancelled
completedAtdatetime or null
Timestamp when the redemption was completed
contactIdlong or null
Unique identifier for the contact
createdAtdatetime or null
Timestamp when the redemption was created
debitTransactionIdstring or nullformat: "uuid"
Unique identifier for the debit transaction
expiresAtdatetime or null
Timestamp when the redemption expires
idstring or nullformat: "uuid"
Unique identifier for the redemption
loyaltyProgramIdstring or nullformat: "uuid"
Unique identifier for the loyalty program
metamap from strings to any or null
Additional metadata associated with the redemption
rejectReasonstring or null
Reason for rejection if the redemption was rejected
rejectedAtdatetime or null
Timestamp when the redemption was rejected
rewardAttributionIdstring or nullformat: "uuid"
Unique identifier for the reward attribution
statusstring or null
Current status of the redemption
updatedAtdatetime or null
Timestamp when the redemption was last updated

Errors