Skip to content
E-Vouchers

List E-Vouchers

Paginated query of the Client's e-voucher rewards, filtered by not claimed or claimed and by valid or invalid, with counts for each group, for the e-voucher tab on the cards page. When all four counts are 0, you can hide the tab. Unclaimed e-vouchers (deliver_status is 0) can be claimed with POST /rewards/activate_prize_ticket.

An empty list means there is no more data.

GEThttps://api.lbkrs.com/rewards/prize_ticket_list

Parameters

account_channelstringqueryRequired

Broker channel

currentstringqueryRequired

Page number, starting from 1

page_sizestringqueryRequired

Page size

ticket_statusstringqueryRequired

Claim status:

  • 0 - Not claimed
  • 1 - Claimed

01

efficient_statusstringqueryRequired

Validity:

  • 0 - Valid
  • 1 - Invalid

01

Responses

HTTP 200The request succeeded. The response body contains the result of the “List e-vouchers” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total e-vouchers matching the filters

nonactivated_countinteger

Count of valid unclaimed e-vouchers

activated_countstring

Count of valid claimed e-vouchers

nonactivated_expired_countstring

Count of invalid unclaimed e-vouchers

activated_expired_countstring

Count of invalid claimed e-vouchers

listarray<object>

E-vouchers

Child attributes
prize_idstring

E-voucher ID; pass it as prize_id when claiming

titlestring

E-voucher title

coverstring

Cover image URL

descriptionstring

Client-facing description

detailstring

E-voucher details

prize_typeinteger

Prize business type; same meaning as prize.prize_type in GET /rewards/member_reward_list

deliver_statusinteger

Delivery status:

  • 0 - Not claimed
  • 1 - Claimed and usable
  • 2 - Used
  • 5 - Claim in progress
  • 6 - Expired; can no longer be claimed
  • 7 - Invalid; can no longer be used
Values
0
1
2
5
6
7
send_timeinteger

Grant timestamp (seconds)

end_timeinteger

Claim deadline timestamp (seconds); 0 means no deadline

effective_timeinteger

Validity end timestamp after claiming (seconds); 0 means always valid

goods_resultstring

Result after claiming, such as a QR code URL or card number details

Whale Docs