Skip to content
Longport WhaleLongport Whale
Trading

Submit IPO Subscription

Submits an IPO subscription application using the selected subscription method (cash, financing, zero-principal, and so on), subscription tier, and benefit cards. On success, returns the subscription order information. The subscription amount is frozen in real time once the application is submitted.

POSThttps://api.lbkrs.com/v1/ipo/submit

Request body application/json

counter_idstringrequired

IPO security id, for example ST/HK/2636

sub_qtystringrequired

Number of shares to subscribe, taken from apply_num_sub of the selected subscription tier

sub_amountstringrequired

Subscription amount, taken from payable of the selected subscription tier

financing_amountstringrequired

Financing amount, rounded to 2 decimal places; "0.00" for cash subscription

financing_intereststringrequired

Financing ratio, the actual financing ratio calculated by the Broker App ("0" for cash subscription)

methodintegerrequired

Subscription method, taken from value of the selected subscription method:

  • 1: Financed subscription
  • 2: Cash subscription
  • 3: HK channel financed subscription
  • 5: Zero-principal subscription
  • 6: Dynamic financed subscription
Values
1
2
3
5
6
batch_idstring

Financing pool batch id, taken from batch_id of the selected subscription method; "0" for subscription methods that do not use a financing pool

cardsarray<object>

Benefit cards used for this subscription; pass an empty array if none are used

Child attributes
card_idstring

Card id

card_typestring

Card type: ipo_commission IPO fee card, ipo_interest IPO financing interest card

currencystring

Card currency

result_amountstring

Fee after the card deduction: for an IPO fee card, the handling fee after deduction; for an IPO financing interest card, the daily interest after the interest subsidy. The Broker App passes it as a string formatted with thousands separators

bz_typesarray<integer>

IPO subscription types the card applies to; for an IPO fee card, pass the card's ipo_commission.bz_types: 1 financed IPO subscription, 2 cash IPO subscription

total_amountstring

Total interest subsidy amount / total deduction amount; currently not passed by the Broker App

account_channelstring

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Submit IPO subscription” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring

Subscription order id, used to navigate to the subscription result page or order details

namestring

IPO name

codestring

IPO stock code

marketstring

Market, for example HK or US

counter_idstring

IPO security id

currencystring

Subscription currency

methodinteger

Subscription method: 1 financed subscription, 2 cash subscription, 3 HK channel financed subscription, 5 zero-principal subscription, 6 dynamic financed subscription

multiplestring

Financing multiple

batch_idstring

Financing pool batch id

sub_qtystring

Number of shares subscribed

sub_amountstring

Subscription amount

sub_feestring

Subscription handling fee

total_amountstring

Total amount

current_amountstring

Cash in the current currency

financing_amountstring

Financing amount

financing_intereststring

Financing interest

finance_fee_ratestring

Financing interest rate

borrow_enableboolean

Whether currency borrowing (broker financing) is supported

borrow_amountstring

Currency borrowing (broker financing) amount

borrow_intereststring

Currency borrowing (broker financing) interest

need_to_paystring

Amount to be topped up

explanationstring

Explanation text for the top-up payment

refund_amountstring

Amount to be refunded

lot_win_qtystring

Number of shares allotted

lucky_feestring

Allotment fee

ipo_pricestring

Issue price

statusinteger

Subscription order status:

  • 1: Pending debit, funds frozen
  • 2: Debit failed
  • 3: Debited, awaiting allotment results
  • 4: Results announced, allotted
  • 5: Results announced, not allotted
  • 6: Withdrawn by the user
  • 7: Listing halted
  • 8: Rejected
Values
1
2
3
4
5
6
7
8
ipo_statusinteger

IPO listing status:

  • 0: Normal
  • 1: Postponed
  • 2: Cancelled
Values
0
1
2
markinteger

Order type:

  • 0: Regular order
  • 1: Reservation order
Values
0
1
withdrawableboolean

Whether the order can be withdrawn

modify_enableboolean

Whether the order can be modified

reject_textstring

Rejection reason

luck_atstring

Allotment result announcement time, Unix timestamp (in seconds)

ipo_datestring

Listing time, Unix timestamp (in seconds)

mart_beginstring

Grey market start time, Unix timestamp (in seconds)

mart_endstring

Grey market end time, Unix timestamp (in seconds)

account_channelstring

Tenant channel the order belongs to

channelstring

Order placement channel

timelinearray<object>

Subscription progress timeline

Child attributes
namestring

Node name

lightboolean

Whether the node is highlighted

timestring

Node time

descstring

Node description

cardsarray<object>

Results of the benefit cards used for this subscription

Child attributes
card_idstring

Card id

card_typestring

Card type: ipo_interest IPO financing interest card, ipo_commission IPO fee card

statusinteger

Card usage status:

  • 0: Not checked
  • 1: Used successfully
  • 2: Card returned
  • 3: Usage failed
Values
0
1
2
3
origin_amountstring

Original daily financing interest / original handling fee

delta_amountstring

Fee after deduction

bz_typesarray<integer>

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

using_cardarray<object>

Details of the benefit cards currently held by the order

Child attributes
card_idstring

Card id

card_typestring

Card type: ipo_interest IPO financing interest card, ipo_commission IPO fee card

titlestring

Card/voucher title

title_secstring

Card/voucher subtitle

descriptionstring

Card/voucher description

card_statusinteger

Card status

currencystring

Amount currency

amountstring

Amount associated with the card

start_timestring

Time from which the card can be used, Unix timestamp (in seconds)

end_timestring

Expiry time, Unix timestamp (in seconds)

bz_typesarray<integer>

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

ipo_commissionobject

IPO fee card attributes

Child attributes
bz_typesarray<integer>

Applicable IPO subscription types: 1 financed IPO subscription, 2 cash IPO subscription

financing_limitstring

Financing amount threshold

counter_idstring

Designated IPO security id; empty means no restriction

ipo_interestobject

IPO financing interest card attributes

Child attributes
discount_ratestring

Interest discount rate

buy_limitobject

Buying power information after the subscription; fields have the same meaning as in the /v1/ipo/inventory/cash response

Child attributes
total_amountstring

IPO buying power

current_amountstring

Withdrawable amount in the current currency (including money market fund (MMF))

mmf_amountstring

Money market fund (MMF) amount

cash_amountstring

Cash amount in the current currency

cash_withdrawstring

Withdrawable cash amount in the current currency

ipo_buy_limitstring

IPO buying power limit

docobject

Subscription explanation text; same fields as doc in the /v3/ipo/info response

Child attributes
subscription_methodstring

Subscription method explanation

buying_powerstring

IPO buying power explanation

financing_intereststring

Financing interest explanation

cut_off_timestring

Subscription cut-off time explanation

financing_estimatestring

Broker financing estimate explanation

noticestring

Notice, in HTML rich text

subscription_statementstring

Subscription statement explanation

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs