Redemption

When a customer opens their gift, they see their reward, a voucher code and a QR code. At your store or checkout, check the code and mark it used. Each code works once.

Three ways to redeem

  • Portal, Redeem page: type the code to check and redeem it. To scan QR codes, use the EFIQ Rewards QR app. Shows the reward, the customer, and whether it was already used.
  • API: from your POS, app or checkout, with an API key that has vouchers:read and redemptions:write (the “Store / POS” preset).
  • Campaigns dashboard: “Verify voucher” works on the same records, so a code used in one place shows as used everywhere.

Check a code

GET /v1/Services/{ServiceSid}/Vouchers/{Code}
curl https://api-rewards.efiqone.com/v1/Services/RS2290…/Vouchers/ABCD-1234-EFGH   -u SK3c8d…:$EFIQ_API_KEY_SECRET

{
  "link_sid": "LKa81e…",
  "voucher_code": "ABCD-1234-EFGH",
  "status": "claimed",
  "can_redeem": true,
  "reward": { "name": "₹500 Cashback Voucher", "type": "FLAT_AMOUNT", "value": 500 },
  "campaign_name": "Diwali thank you",
  "external_user_id": "crm_contact_1042",
  "customer_name": "Priya Sharma",
  "date_claimed": "2026-11-12T10:42:07.000Z",
  "date_redeemed": null,
  "date_expires": "2026-12-31T18:29:59.000Z"
}
statusMeaningcan_redeem
claimedThe customer opened the gift and has the codeyes
not_openedThe link hasn’t been opened yetyes
redeemedAlready used (see date_redeemed, redeemed_by, location)no
expiredPast its expiry dateno
revokedYou revoked the linkno

Spaces, dashes and lower case in the code don’t matter. Only links created through that Service are found.

Mark it used

POST /v1/Services/{ServiceSid}/Redemptions
curl -X POST https://api-rewards.efiqone.com/v1/Services/RS2290…/Redemptions   -u SK3c8d…:$EFIQ_API_KEY_SECRET   --data-urlencode "Code=ABCD-1234-EFGH"   --data-urlencode "RedeemedBy=Counter 2"   --data-urlencode "Location=Indiranagar store"

Returns the voucher with status: redeemed. Or redeem by link: POST /v1/Services/{ServiceSid}/Links/{LinkSid}/Redeem. Your webhooks receive link.redeemed.

ErrorHTTPWhen
20905409Already redeemed. The message says when.
20411410The voucher expired
20410410The link was revoked
20404404No such code for this Service
Two counters redeeming the same code at the same moment is safe: exactly one succeeds, the other gets 20905.