Skip to content
E-Vouchers

Claim an E-Voucher

Claims an unclaimed e-voucher (deliver_status is 0). The request body is form-encoded.

  • status is 1: Claimed. You can show the validity end effective_time and guide the Client to use it.
  • status is 0: Accepted but not complete; for example, a voucher can take several business days to arrive. Query the e-voucher list or prize details again later to confirm.

The prize details page also uses this endpoint to claim e-vouchers that require contact details; in that case pass the Client's contact details in extra. On failure, show message.

POSThttps://api.lbkrs.com/rewards/activate_prize_ticket

Request body application/x-www-form-urlencoded

prize_idstringrequired

E-voucher ID, from prize_id in the e-voucher list or prize details

extrastringrequired

Additional information as a JSON string. Pass an empty string for regular e-vouchers; for e-vouchers that require contact details, pass JSON with email, name, and phone

Responses

HTTP 200The request succeeded. The response body contains the result of the “Claim an e-voucher” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
statusinteger

Claim result:

  • 0 - Accepted; waiting to arrive
  • 1 - Claimed
Values
0
1
effective_timeinteger

Validity end timestamp (seconds); applies when status is 1

Whale Docs