Redeem a reward
Spend a card balance and issue a reward code. Send reward_id to redeem a catalog reward (points and stamps programs), or amount to spend money from a cashback or gift card balance.
Endpoint
POST/loyalty-redemptions
Request
Redeem a catalog reward
Spend a cashback or gift card balance
Response
json
Returns the redemption. Without mark_used, status is issued: give the code to the customer and mark it used when the reward is handed over.
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of your organization |
member_id | Number | Yes | ID of the card |
reward_id | Number | One of reward_id / amount | Reward of the card's program (Loyalty Rewards) |
amount | Number | One of reward_id / amount | Cashback and gift cards: amount to spend, in the program currency |
mark_used | Boolean | No | true marks the code as used at once (reward handed over at the counter) |
channel | String | No | Defaults to api for API key requests |
Business rules
The request returns 400 Bad Request with one of these messages when a rule is not met:
| Message | Cause |
|---|---|
Not enough balance for this reward | The card balance is below the reward cost |
Not enough balance | The card balance is below amount |
This reward requires the Gold tier | The reward has a minimum tier the member has not reached (the tier name varies) |
This reward is out of stock | The reward stock is used up |
This reward is not available | The reward is inactive |
The minimum to redeem is 10 | Cashback: amount is below the program min_redeem_amount |
Only cashback and gift card balances can be spent by amount | amount was sent for a points, stamps or membership card |
This card is blocked / This card has expired | The card cannot be used |
This program is not active | The program is draft, paused or archived |
reward_id or amount is required | Neither was sent |
Reward not found (404) is returned when the reward does not belong to the card's program.
Report an issue with this documentation
Please log in to report issues with our documentation.