Skip to content
Cards

Get Redeemable Fractional-Share Cards

Returns the Client's fractional-share cards that can be redeemed for the specified stock, split into cards bound to that stock and general cards, for the redemption page where the Client selects cards and sees the redeemable shares. After selection, call POST /rewards/realize_stock_fragment_card to redeem.

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

Parameters

account_channelstringqueryRequired

Broker channel

counter_idstringqueryRequired

counter_id of the stock to redeem

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get redeemable fractional-share cards” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
counter_idstring

counter_id of the queried stock

stock_listarray<object>

Fractional-share cards bound to this stock

Child attributes
card_idstring

Card/Coupon id

member_idstring

The member_id of the Client who holds the card.

card_typestring

Card/Coupon type: cash Cash card, quote Market data card, fundamental Fundamental card, commission Commission-free card, ipo IPO privilege card, ipo_interest IPO financing interest card, ipo_commission IPO fee card, stock Stock card, stock_fragment Fractional share card, platform_fee_deduct Platform fee deduction card, finance_interest Margin financing interest card, fund_interest Fund interest-boost card, coffee_coupon Coffee coupon

Values
cash
quote
fundamental
commission
ipo
ipo_interest
ipo_commission
stock
stock_fragment
platform_fee_deduct
finance_interest
fund_interest
coffee_coupon
titlestring

Card/Coupon title

title_secstring

Card/Coupon subtitle

coverstring

Cover image

descriptionstring

Client-facing description.

start_timestring

Usable start timestamp (seconds)

end_timestring

Expiry timestamp (seconds)

card_statusinteger

Coupon/voucher status:

  • 0 - Not activated
  • 1 - Used
  • 2 - Expired
  • 3 - In use
  • 4 - Activated
Values
0
1
2
3
4
detailstring

Card/Coupon details

currencystring

Currency unit, applicable to Cash cards, Commission-free cards, IPO financing interest cards, IPO fee cards

amountstring

Associated amount

activate_timestring

Card/Coupon activation time

invisibleboolean

Is invisible (used only in available-cards list scenario)

backgroundstring

Card/Coupon background image

stylestring

Card/Coupon style

account_channelstring

Account channels applicable to the card/coupon

new_flagboolean

New card indicator

cashobject

Cash card information

Child attributes
receive_durationstring

Cash arrival time required (seconds)

quoteobject

Market data card / Fundamental card information

Child attributes
quote_durationstring

Permission duration (seconds)

marketsarray<string>

Entitlement market(s)

superpositionboolean

Is time stackable

quote_marketstring

Market data market

current_end_timestring

Current expiration time

manual_activateboolean

Requires manual activation

need_certifyboolean

Requires professional investor accreditation

fundamentalobject

Market data card / Fundamental card information

Child attributes
quote_durationstring

Permission duration (seconds)

marketsarray<string>

Entitlement market(s)

superpositionboolean

Is time stackable

quote_marketstring

Market data market

current_end_timestring

Current expiration time

manual_activateboolean

Requires manual activation

need_certifyboolean

Requires professional investor accreditation

commissionobject

Commission-free card information

Child attributes
marketsarray<string>

Commission-free markets, e.g. US, SH, SG, HK

rebate_ratestring

Commission-free ratio, 1 represents 100%

bz_typesarray<integer>

Applicable instrument types

commission_durationstring

Commission-free card duration (seconds)

commission_balancestring

Commission-free card balance

unlimitedinteger

Commission-free mode:

  • 0 - Proportional commission-free (collect first, rebate later; time-limited)
  • 1 - Full commission-free (collect first, rebate later; time-limited)
  • 2 - Lifetime commission-free (direct deduction; no usage limit)
  • 6 - Fixed-amount per-use card (usage count limit, time-limited)
  • 7 - Discount per-use card (usage count limit, time-limited)
Values
0
1
2
6
7
commission_expired_timestring

Commission-free expiry time (for commission-free cards currently in use)

superpositionboolean

Is time stackable

settlement_modelstring

Settlement mode: payback charge-first-refund-later, compensate direct deduction

Values
payback
compensate
usage_countstring

Commission-free card usage count

lave_usage_countstring

Remaining available uses

amount_limitstring

Per-use amount cap (unit: cents); absence means no limit

ipoobject

IPO privilege card information

Child attributes
subscription_idstring

Reservation id; empty means generalized IPO card

ipo_interestobject

IPO financing interest card information

Child attributes
discount_ratestring

Subsidy interest rate, 1 represents 100%

ipo_commissionobject

IPO fee card information

Child attributes
bz_typesarray<integer>

IPO method

financing_limitstring

Financing IPO quota threshold, 0 means no threshold

counter_idstring

Specified IPO stock id; empty means no restriction

stockobject

Stock card information

Child attributes
counter_idstring

Stock id

amountnumber

Number of shares issued, supports fractional shares

redemption_typestring

Redemption type: by_card_value redeem by card face value, shares_number fixed shares redemption (default)

Values
by_card_value
shares_number
stock_fragmentobject

Fractional-share card information.

Child attributes
counter_idstring

Applicable stock id; empty means fractional-share general card

marketsarray<string>

Applicable market

amountsobject

Issuance quantity per market

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)
Values
0
1
2
3
4
platform_fee_deductobject

Platform fee deduction card information

Child attributes
usage_countstring

Usage count

lave_usage_countstring

Remaining available uses

superpositionboolean

Is time stackable

marketsarray<string>

Applicable market

bz_typesarray<integer>

Applicable instrument types

counter_idstring

Applicable stock id

finance_interestobject

Financing interest card information

Child attributes
discount_modeinteger

Discount method

discount_ratenumber

Discount rate

superpositionboolean

Is stackable/extendable

fund_interestobject

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

coffee_couponobject

Coffee coupon information

Child attributes
coupon_channelstring

Card/Coupon channel

coupon_nostring

Third-party card/coupon number

use_limitstring

Usage limit type: total total-use limit, period periodic-use limit

Values
total
period
thresholdstring

Maximum uses

period_typestring

Period type (effective when use_limit is period), e.g. day

coupon_idstring

Third-party card/coupon id

store_id_listarray<string>

Store IDs where the coupon can be used.

is_available_all_storeboolean

Whether the coupon can be used at every store.

settled_store_idstring

ID of the store where the coupon was redeemed.

store_listarray<object>

Stores where the coupon can be used. The item schema is not defined.

cryptoobject

Virtual asset card information. The object schema is not defined.

ai_benefitobject

AI benefit card information.

Child attributes
benefit_tagstring

Entitlement tag

benefit_daysinteger

Entitlement days

benefit_startstring

Entitlement start time

benefit_endstring

Entitlement end time

receive_durationstring

Time for cash to arrive (seconds). Deprecated and pending removal; semantics same as cash.receive_duration; retained only for compatibility with legacy Broker App.

quote_durationstring

Permission duration (seconds). Deprecated and pending removal; semantics same as quote.quote_duration; retained only for compatibility with legacy Broker App.

marketsarray<string>

Commission-free markets. Deprecated and pending removal; semantics same as commission.markets; retained only for compatibility with legacy Broker App.

rebate_ratestring

Commission-free rebate rate. Deprecated and pending removal; semantics same as commission.rebate_rate; retained only for compatibility with legacy Broker App.

bz_typesarray<integer>

Applicable underlying types. Deprecated and pending removal; semantics same as commission.bz_types; retained only for compatibility with legacy Broker App.

commission_balancestring

Commission-free card balance. Deprecated and pending removal; semantics same as commission.commission_balance; retained only for compatibility with legacy Broker App.

commission_durationstring

Commission-free card duration (seconds). Deprecated and pending removal; semantics same as commission.commission_duration; retained only for compatibility with legacy Broker App.

subscription_idstring

IPO privilege card subscription id. Deprecated and pending removal; semantics same as ipo.subscription_id; retained only for compatibility with legacy Broker App.

general_listarray<object>

General fractional-share cards redeemable for any eligible stock

Child attributes
card_idstring

Card/Coupon id

member_idstring

The member_id of the Client who holds the card.

card_typestring

Card/Coupon type: cash Cash card, quote Market data card, fundamental Fundamental card, commission Commission-free card, ipo IPO privilege card, ipo_interest IPO financing interest card, ipo_commission IPO fee card, stock Stock card, stock_fragment Fractional share card, platform_fee_deduct Platform fee deduction card, finance_interest Margin financing interest card, fund_interest Fund interest-boost card, coffee_coupon Coffee coupon

Values
cash
quote
fundamental
commission
ipo
ipo_interest
ipo_commission
stock
stock_fragment
platform_fee_deduct
finance_interest
fund_interest
coffee_coupon
titlestring

Card/Coupon title

title_secstring

Card/Coupon subtitle

coverstring

Cover image

descriptionstring

Client-facing description.

start_timestring

Usable start timestamp (seconds)

end_timestring

Expiry timestamp (seconds)

card_statusinteger

Coupon/voucher status:

  • 0 - Not activated
  • 1 - Used
  • 2 - Expired
  • 3 - In use
  • 4 - Activated
Values
0
1
2
3
4
detailstring

Card/Coupon details

currencystring

Currency unit, applicable to Cash cards, Commission-free cards, IPO financing interest cards, IPO fee cards

amountstring

Associated amount

activate_timestring

Card/Coupon activation time

invisibleboolean

Is invisible (used only in available-cards list scenario)

backgroundstring

Card/Coupon background image

stylestring

Card/Coupon style

account_channelstring

Account channels applicable to the card/coupon

new_flagboolean

New card indicator

cashobject

Cash card information

Child attributes
receive_durationstring

Cash arrival time required (seconds)

quoteobject

Market data card / Fundamental card information

Child attributes
quote_durationstring

Permission duration (seconds)

marketsarray<string>

Entitlement market(s)

superpositionboolean

Is time stackable

quote_marketstring

Market data market

current_end_timestring

Current expiration time

manual_activateboolean

Requires manual activation

need_certifyboolean

Requires professional investor accreditation

fundamentalobject

Market data card / Fundamental card information

Child attributes
quote_durationstring

Permission duration (seconds)

marketsarray<string>

Entitlement market(s)

superpositionboolean

Is time stackable

quote_marketstring

Market data market

current_end_timestring

Current expiration time

manual_activateboolean

Requires manual activation

need_certifyboolean

Requires professional investor accreditation

commissionobject

Commission-free card information

Child attributes
marketsarray<string>

Commission-free markets, e.g. US, SH, SG, HK

rebate_ratestring

Commission-free ratio, 1 represents 100%

bz_typesarray<integer>

Applicable instrument types

commission_durationstring

Commission-free card duration (seconds)

commission_balancestring

Commission-free card balance

unlimitedinteger

Commission-free mode:

  • 0 - Proportional commission-free (collect first, rebate later; time-limited)
  • 1 - Full commission-free (collect first, rebate later; time-limited)
  • 2 - Lifetime commission-free (direct deduction; no usage limit)
  • 6 - Fixed-amount per-use card (usage count limit, time-limited)
  • 7 - Discount per-use card (usage count limit, time-limited)
Values
0
1
2
6
7
commission_expired_timestring

Commission-free expiry time (for commission-free cards currently in use)

superpositionboolean

Is time stackable

settlement_modelstring

Settlement mode: payback charge-first-refund-later, compensate direct deduction

Values
payback
compensate
usage_countstring

Commission-free card usage count

lave_usage_countstring

Remaining available uses

amount_limitstring

Per-use amount cap (unit: cents); absence means no limit

ipoobject

IPO privilege card information

Child attributes
subscription_idstring

Reservation id; empty means generalized IPO card

ipo_interestobject

IPO financing interest card information

Child attributes
discount_ratestring

Subsidy interest rate, 1 represents 100%

ipo_commissionobject

IPO fee card information

Child attributes
bz_typesarray<integer>

IPO method

financing_limitstring

Financing IPO quota threshold, 0 means no threshold

counter_idstring

Specified IPO stock id; empty means no restriction

stockobject

Stock card information

Child attributes
counter_idstring

Stock id

amountnumber

Number of shares issued, supports fractional shares

redemption_typestring

Redemption type: by_card_value redeem by card face value, shares_number fixed shares redemption (default)

Values
by_card_value
shares_number
stock_fragmentobject

Fractional-share card information.

Child attributes
counter_idstring

Applicable stock id; empty means fractional-share general card

marketsarray<string>

Applicable market

amountsobject

Issuance quantity per market

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)
Values
0
1
2
3
4
platform_fee_deductobject

Platform fee deduction card information

Child attributes
usage_countstring

Usage count

lave_usage_countstring

Remaining available uses

superpositionboolean

Is time stackable

marketsarray<string>

Applicable market

bz_typesarray<integer>

Applicable instrument types

counter_idstring

Applicable stock id

finance_interestobject

Financing interest card information

Child attributes
discount_modeinteger

Discount method

discount_ratenumber

Discount rate

superpositionboolean

Is stackable/extendable

fund_interestobject

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

coffee_couponobject

Coffee coupon information

Child attributes
coupon_channelstring

Card/Coupon channel

coupon_nostring

Third-party card/coupon number

use_limitstring

Usage limit type: total total-use limit, period periodic-use limit

Values
total
period
thresholdstring

Maximum uses

period_typestring

Period type (effective when use_limit is period), e.g. day

coupon_idstring

Third-party card/coupon id

store_id_listarray<string>

Store IDs where the coupon can be used.

is_available_all_storeboolean

Whether the coupon can be used at every store.

settled_store_idstring

ID of the store where the coupon was redeemed.

store_listarray<object>

Stores where the coupon can be used. The item schema is not defined.

cryptoobject

Virtual asset card information. The object schema is not defined.

ai_benefitobject

AI benefit card information.

Child attributes
benefit_tagstring

Entitlement tag

benefit_daysinteger

Entitlement days

benefit_startstring

Entitlement start time

benefit_endstring

Entitlement end time

receive_durationstring

Time for cash to arrive (seconds). Deprecated and pending removal; semantics same as cash.receive_duration; retained only for compatibility with legacy Broker App.

quote_durationstring

Permission duration (seconds). Deprecated and pending removal; semantics same as quote.quote_duration; retained only for compatibility with legacy Broker App.

marketsarray<string>

Commission-free markets. Deprecated and pending removal; semantics same as commission.markets; retained only for compatibility with legacy Broker App.

rebate_ratestring

Commission-free rebate rate. Deprecated and pending removal; semantics same as commission.rebate_rate; retained only for compatibility with legacy Broker App.

bz_typesarray<integer>

Applicable underlying types. Deprecated and pending removal; semantics same as commission.bz_types; retained only for compatibility with legacy Broker App.

commission_balancestring

Commission-free card balance. Deprecated and pending removal; semantics same as commission.commission_balance; retained only for compatibility with legacy Broker App.

commission_durationstring

Commission-free card duration (seconds). Deprecated and pending removal; semantics same as commission.commission_duration; retained only for compatibility with legacy Broker App.

subscription_idstring

IPO privilege card subscription id. Deprecated and pending removal; semantics same as ipo.subscription_id; retained only for compatibility with legacy Broker App.

Whale Docs