Get Client Rewards List

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

Parameters

currentstringqueryRequired

Page number, starting from 1

page_sizestringqueryRequired

Items per page, default 10, max 50

reward_typestringqueryRequired

Reward type filter：

-1 - All
0 - Cash
1 - Physical item
2 - Coupon/voucher
3 - Task coin

-10123

account_channelstringqueryRequired

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Client rewards list” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>

Rewards list

Child attributes

reward_typeinteger

Reward type：

0 - Cash
1 - Physical item
2 - Coupon/voucher
3 - Task coin

0123

account_channelstring

Applicable tenant(s)

cashobject

Cash reward information

Child attributes

record_idstring

Record id

activity_titlestring

Campaign name

currencystring

Currency

amountnumber

Amount

statusinteger

Issuance status (applicable values vary slightly by reward type)：

0 - Pending issuance
1 - Issuance cancelled
2 - Withdrawn from campaign
8 - Awaiting claim
10 - Issuing
12 - Issued
13 - Issuance failed
16 - Redeemed (coupon/voucher only)
17 - Expired (physical/coupon only)

01281012131617

exit_statusinteger

Cancel issuance reason (only meaningful when status=1 cancelled issuance)：

0 - Did not meet campaign threshold
1 - Campaign mutually exclusive

01

send_timestring

Grant time; if not yet granted, this is the expected grant time

task_coinobject

Task token reward information

Child attributes

record_idstring

Record id

activity_titlestring

Campaign name

amountnumber

Quantity

statusinteger

Issuance status (applicable values vary slightly by reward type)：

0 - Pending issuance
1 - Issuance cancelled
2 - Withdrawn from campaign
8 - Awaiting claim
10 - Issuing
12 - Issued
13 - Issuance failed
16 - Redeemed (coupon/voucher only)
17 - Expired (physical/coupon only)

01281012131617

exit_statusinteger

Cancel issuance reason (only meaningful when status=1 cancelled issuance)：

0 - Did not meet campaign threshold
1 - Campaign mutually exclusive

01

send_timestring

Grant time; if not yet granted, this is the expected grant time

prizeobject

Physical reward information

Child attributes

record_idstring

Record id

prize_idstring

Physical item id

activity_titlestring

Campaign name

titlestring

Physical item title

coverstring

Cover image

descriptionstring

Client-facing description.

statusinteger

Issuance status (applicable values vary slightly by reward type)：

0 - Pending issuance
1 - Issuance cancelled
2 - Withdrawn from campaign
8 - Awaiting claim
10 - Issuing
12 - Issued
13 - Issuance failed
16 - Redeemed (coupon/voucher only)
17 - Expired (physical/coupon only)

01281012131617

exit_statusinteger

Cancel issuance reason (only meaningful when status=1 cancelled issuance)：

0 - Did not meet campaign threshold
1 - Campaign mutually exclusive

01

send_timestring

Grant time

deliver_orderstring

Logistics/tracking number; present only when shipped

detailstring

Physical item details

deliver_statusinteger

Delivery status (used for subsequent states of status=12 - Issued)：

0 - Not activated
1 - Activated
2 - Consumed
5 - E-voucher activating
6 - E-voucher expired and cannot be activated
7 - E-voucher invalid and cannot be consumed

012567

prize_typeinteger

Physical goods business type：

0 - Physical product
1 - E-voucher

01

provider_codestring

E-voucher provider: chengquan (Chengquan provider), manager (contact account manager to obtain), deposit (deposit), apple_card (Apple top-up card)

chengquanmanagerdepositapple_card

end_timestring

E-voucher unactivated expiry time; 0 means does not expire

goods_resultstring

Result after e-voucher activation, e.g., QR code URL or Apple card serial number (JSON)

effective_timestring

Validity period after e-voucher activation; 0 means always valid

reward_rule_urlstring

Link to reward distribution rules; when both this and reward_rule_description exist, this link often takes priority

reward_rule_descriptionstring

Reward distribution rule description

campaign_codestring

Campaign code

express_infoobject

Logistics information for physical item delivery

Child attributes

addresseestring

Recipient

phonestring

Phone

shipping_addressstring

Shipping address

provincestring

Province

citystring

City

districtstring

District

delivery_typestring

Delivery method：

1 - Self pickup
2 - Mail

pickup_infoobject

Self-pickup information

Child attributes

briefstring

Brief description

detailstring

Detailed description

emailstring

country_codestring

Country/region code

receive_deadlinestring

Physical goods collection deadline

delivery_typesarray<integer>

Physical product delivery method：

1 - Self pickup
2 - Mail

addressesarray<object>

Physical goods pickup address information

Child attributes

briefstring

Address short name

detailstring

Address details

coupon_secret_idstring

0 indicates no stock at the time of reward grant; restocking required later

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

0123

expire_atstring

Redemption deadline

to_cash_cardboolean

Can be redeemed for a cash card

cash_card_codestring

Cash card code

cash_card_valueobject

Cash card value

coupon_secret_typestring

E-voucher type

cardobject

Coupon/card reward information

Child attributes

record_idstring

Record id

card_idstring

Card/Coupon id

activity_titlestring

Campaign name

card_typestring

Card/coupon type: cash cash card, quote market data card, fundamental fundamental card, commission commission-free card

cashquotefundamentalcommission

titlestring

Card/Coupon title

coverstring

Cover image

descriptionstring

Client-facing description.

statusinteger

Issuance status (applicable values vary slightly by reward type)：

0 - Pending issuance
1 - Issuance cancelled
2 - Withdrawn from campaign
8 - Awaiting claim
10 - Issuing
12 - Issued
13 - Issuance failed
16 - Redeemed (coupon/voucher only)
17 - Expired (physical/coupon only)

01281012131617

exit_statusinteger

Cancel issuance reason (only meaningful when status=1 cancelled issuance)：

0 - Did not meet campaign threshold
1 - Campaign mutually exclusive

01

send_timestring

Grant time; if not yet granted, this is the expected grant time

detailstring

Card/Coupon details

currencystring

Currency unit (attribute of cash card / commission card)

amountnumber

Amount for cash card / commission card

receive_durationstring

Estimated time for cash to arrive after using cash card (seconds)

quote_durationstring

Duration (seconds), attribute of market data card / fundamental card

marketsarray<string>

Commission-free card markets

rebate_ratestring

Commission-free rate for commission card

commission_durationstring

Commission-free card duration (seconds)

backgroundstring

Card/Coupon background image

stylestring

Card/Coupon style

card_statusinteger

Voucher usage status：

0 - Not used
1 - Used
2 - Expired
3 - In use

0123

reward_rule_urlstring

Link to reward distribution rules; when both this and reward_rule_description exist, this link often takes priority

reward_rule_descriptionstring

Reward distribution rule description

short_backgroundstring

Thumbnail background image, mainly used in reward record display

fund_interestobject

Fund interest-boost card information (structure is dynamic JSON; fields are not fixed)

quoteobject

Market data card related information (structure is dynamic JSON; fields not fixed)

stock_fragmentobject

Fractional-share card information.

Child attributes

underlying_typeinteger

Underlying/instrument type：

0 - Stock trading
1 - US equity options
2 - HK warrants
3 - Exchange-traded funds (ETF)
4 - Off-exchange funds (LOF)

01234

ai_benefitobject

AI benefit card information.

totalstring

Total count

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/rewards/member_reward_list"
)
request.query = [
    "current": 1,
    "page_size": 10,
    "reward_type": -1,
    "account_channel": "lb"
]

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "reward_type": 0,
        "cash": {
          "record_id": "<REWARD_RECORD_ID>",
          "activity_title": "Stock Card Redemption Cashback",
          "currency": "HKD",
          "amount": 100,
          "status": 12,
          "exit_status": 0,
          "send_time": "1762321829"
        },
        "prize": null,
        "card": null,
        "task_coin": null,
        "account_channel": "lb"
      },
      {
        "reward_type": 2,
        "cash": null,
        "prize": null,
        "card": {
          "record_id": "<REWARD_RECORD_ID>",
          "card_id": "<CARD_ID>",
          "activity_title": "Longbridge Café Opening Promotion",
          "card_type": "coffee_coupon",
          "title": "Designated Coffee Free Drink Voucher",
          "cover": "https://assets.lbctrl.com/uploads/045892a9-67c6-490a-96b6-b051b94b5fb0/e_voucher_icon.png",
          "description": "Redeemable at Longbridge Café",
          "status": 12,
          "exit_status": 0,
          "send_time": "1758124852",
          "detail": "",
          "currency": "",
          "amount": 0,
          "receive_duration": "0",
          "quote_duration": "0",
          "markets": [],
          "rebate_rate": "",
          "commission_duration": "0",
          "background": "#CD8949",
          "style": "",
          "card_status": 2,
          "reward_rule_url": "",
          "reward_rule_description": "",
          "short_background": "",
          "fund_interest": null,
          "quote": null,
          "stock_fragment": null,
          "ai_benefit": null
        },
        "task_coin": null,
        "account_channel": "lb"
      }
    ],
    "total": "107"
  }
}