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

NameTypeRequiredDescription
organization_idNumberYesID of your organization
member_idNumberYesID of the card
reward_idNumberOne of reward_id / amountReward of the card's program (Loyalty Rewards)
amountNumberOne of reward_id / amountCashback and gift cards: amount to spend, in the program currency
mark_usedBooleanNotrue marks the code as used at once (reward handed over at the counter)
channelStringNoDefaults 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:

MessageCause
Not enough balance for this rewardThe card balance is below the reward cost
Not enough balanceThe card balance is below amount
This reward requires the Gold tierThe reward has a minimum tier the member has not reached (the tier name varies)
This reward is out of stockThe reward stock is used up
This reward is not availableThe reward is inactive
The minimum to redeem is 10Cashback: amount is below the program min_redeem_amount
Only cashback and gift card balances can be spent by amountamount was sent for a points, stamps or membership card
This card is blocked / This card has expiredThe card cannot be used
This program is not activeThe program is draft, paused or archived
reward_id or amount is requiredNeither 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.