Skip to content
Physical Prizes

Claim a Redemption Code

Claims a redemption-code prize (prize_type is 3) and returns the card number and code. After success, call GET /rewards/reward_prize_info to view the code details. On failure, show message.

POSThttps://api.lbkrs.com/reward/receive/coupon/secret

Request body application/json

record_idintegerrequired

Prize record ID

coupon_secret_idinteger

Redemption code ID, from the prize's coupon_secret_id

Responses

HTTP 200The request succeeded. The response body contains the result of the “Claim a redemption code” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
coupon_secretobject

E-voucher information

Child attributes
coupon_secret_typestring

E-voucher type

coupon_idstring

Card number

secretstring

Card PIN

statusinteger

E-voucher status:

  • 0 - Available
  • 1 - Locked (reward issued, Client has not yet claimed)
  • 2 - Claimed
  • 3 - Voucher code expired
Values
0
1
2
3
expire_atstring

Redemption deadline

Whale Docs