Redeem Rewards
Confirms the redemption and marks the reward as used. This is done based on the redemptionCode that is generated from the response of the ‘Issue Variable Rewards’ - POST /api/v1/redeem/reward/issue endpoint.
Note:
1) Rewards have to be issued before they can be redeemed.
2) Rewards must be within their expiration date.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Reward details
Redemption code. This code must be specified. Redemption code is generated in the response of the Issue Variable Rewards
(POST /api/v1/redeem/reward/issue) endpoint.
Represents the store where the rewards are being redeemed. Each store (online, physical or POS) has a unique locationExternalReference name or ID.
1
Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.
Representative who is issuing the reward redemption.
1
Was this page helpful?