Get IPO Fee Card

Queries the IPO fee card available to the user when subscribing to the specified IPO. Returns the card/voucher information (title, deduction amount, validity period, applicable IPO subscription method, and so on) and whether the card can currently be claimed. Used to display the fee card entry on the subscription page: if the user already holds the card, it can be selected directly; if the user does not hold it but can claim it, the user is guided to claim it.

GEThttps://api.lbkrs.com/v1/reward/card/ipo

Parameters

counter_idstringqueryRequired

IPO security id, such as ST/HK/2636. If omitted, no error is returned, but the card/voucher information is empty

currencystringquery

Subscription currency, such as HKD. Broker App always passes the IPO subscription currency

bz_typeintegerquery

IPO subscription method, taken from the first value of the current subscription method bz_types: 1 financed IPO subscription, 2 cash IPO subscription

12

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get IPO fee card” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

card_idstring

Card/voucher id. An empty string means the user does not hold the card yet; in this case the card can be claimed if can_receive is true, otherwise no card is available

can_receiveboolean

Whether the IPO fee card can be claimed

card_typestring

Card/voucher type. For an IPO fee card, the value is ipo_commission

titlestring

Card/voucher title

title_secstring

Card/voucher subtitle

descriptionstring

Card/voucher description

detailstring

Card/voucher details

coverstring

Card/voucher cover image URL

backgroundstring

Card/voucher background image URL

stylestring

Card/voucher style

member_idstring

Holder id. "0" if the card is not held

start_timestring

Start time from which the card can be used, Unix timestamp (in seconds). "0" means not set

end_timestring

Expiry time, Unix timestamp (in seconds). "0" means not set

card_statusinteger

Card/voucher status:

0: Unused
1: Used
2: Expired
3: In use

Values

0
1
2
3

currencystring

Currency of the deduction amount

amountstring

Handling fee amount that can be deducted

bz_typesarray<integer>

IPO subscription types the card applies to: 1 financed IPO subscription, 2 cash IPO subscription

counter_idstring

IPO security id specified by the card. An empty string means no restriction

account_channelstring

Tenant channel to which the card applies

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v1/reward/card/ipo"
)
request.query = [
    "counter_id": "ST/HK/2636"
]

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

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "card_id": "",
    "card_type": "ipo_commission",
    "title": "Transsion Holdings IPO Fee Card",
    "title_sec": "Zero handling fee for cash IPO subscription",
    "member_id": "0",
    "cover": "https://pub.pbkrs.com/files/202304/rpbsCpL2WxjFJ7QB/_26.png",
    "description": "Deducts the HKD 49 handling fee for one cash IPO subscription to Transsion Holdings. Invalid after expiry",
    "start_time": "0",
    "end_time": "0",
    "card_status": 0,
    "detail": "",
    "currency": "HKD",
    "amount": "49.00",
    "background": "https://pub.pbkrs.com/files/202211/wJNXvCDb7T93oxv1/background.png",
    "style": "",
    "bz_types": [
      2
    ],
    "counter_id": "ST/HK/2636",
    "account_channel": "lb",
    "can_receive": false
  }
}