Skip to content
International Placing

Get International Placing Subscription Info

Called when the subscription page opens for an international placing security, in place of Get IPO Subscription Info. The response structure is the same as Get IPO Subscription Info: subscription methods, subscription tiers, deadlines, certification and compliance requirements, existing orders of the same kind, and so on, used to display the international placing subscription page and calculate submission parameters. Then submit through Submit International Placing Subscription.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/placement/info

Parameters

counter_idstringqueryRequired

International placing IPO security ID

flagstringquery

Subscription type. Pass 2 for international placing

2

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get International Placing Subscription Info” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
namestring

IPO name

codestring

IPO code, for example "02636"

marketstring

Market, for example HK or US

currencystring

Subscription currency, for example HKD or USD

deadlinestring

Subscription deadline, Unix timestamp (in seconds)

methodsarray<object>

List of available subscription methods (including each financing pool batch). Broker App distinguishes subscription methods by value, and distinguishes different financing pools under the same subscription method by batch_id.

Child attributes
keystring

Subscription method key, for example cash (cash subscription), financing (financed subscription), or financingHK (Hong Kong channel financed subscription)

valueinteger

Subscription method, passed as method when submitting a subscription:

  • 1: Financed subscription
  • 2: Cash subscription
  • 3: Hong Kong channel financed subscription
  • 5: Zero-principal subscription
  • 6: Dynamic financed subscription
Values
1
2
3
5
6
display_namestring

Display name of the subscription method, for example "Cash"

feestring

Subscription handling fee

currencystring

Currency

deadlinestring

Deadline of this subscription method, Unix timestamp (in seconds). Different subscription methods may have different deadlines.

start_atstring

Start time of this subscription method, Unix timestamp (in seconds). "0" means no restriction. The method cannot be selected before the start time.

is_endedboolean

Whether this subscription method has closed

multiplestring

Financing multiple. "1" for cash subscription.

minstring

Minimum financing multiple

maxstring

Maximum financing multiple

ratiostring

Financing ratio or maximum financing ratio. "0" for cash subscription. Broker App calculates the financing amount as "subscription amount × ratio".

finance_fee_ratestring

Annualized financing interest rate, for example "0.0398" means 3.98%

min_cashstring

Minimum subscription principal. "0.00" means no restriction; when greater than 0, the subscription principal cannot be lower than this value.

remaining_amountstring

Remaining quota of the financing pool

is_enoughboolean

Whether the financing pool quota is sufficient. When false, this subscription method cannot be selected.

batch_idstring

Financing pool batch id, passed as is when submitting a subscription. "0" for subscription methods without a financing pool.

tagstring

Quota status text (for example Sufficient quota, Limited quota, Quota exhausted)

tag_colorstring

Color of the quota status text

tagsarray<object>

List of subscription method tags

Child attributes
textstring

Tag text

typeinteger

Tag type:

  • 0: User
  • 1: Quota
Values
0
1
styleinteger

Tag style:

  • 0: No style
  • 1: Sufficient quota
  • 2: Limited quota
  • 3: Quota exhausted
  • 4: User exclusive
Values
0
1
2
3
4
bz_typesarray<integer>

Business types. When querying or claiming IPO fee cards, pass the first value as bz_type: 1 financed IPO subscription, 2 cash IPO subscription

card_typesarray<string>

Benefit card types usable with this subscription method: ipo_interest IPO financing interest card, ipo_commission IPO fee card

upper_limitinteger

Maximum number of shares that can be subscribed. -1 means no restriction. For zero-principal subscription, only tiers not exceeding this value can be selected.

mmf_statusinteger

MMF redemption status, used to display MMF related hints:

  • 1: Auto-redemption available
  • 2: Auto-redemption unavailable (advance funding not enabled)
  • 3: Auto-redemption unavailable (advance funding enabled)
Values
1
2
3
mmf_t2_trade_daystring

MMF T-2 trading day time, Unix timestamp (in seconds)

financing_base_typeinteger

Financing calculation base type. Determines which amount returned by /v1/ipo/inventory/cash Broker App uses as the available principal:

  • 0: Default (uses total_amount)
  • 1: Cash based (uses cash_withdraw)
  • 2: Buying power based (uses ipo_buy_limit)
Values
0
1
2
remarkstring

Remark text of the subscription method. When not empty, it is displayed below the subscription method card.

itemarray<object>

List of subscription tiers (a flat, ungrouped list). When group_item contains grouped data, Broker App uses group_item instead.

Child attributes
serial_numberinteger

Tier sequence number

apply_num_substring

Number of shares subscribed

payablestring

Amount payable

currencystring

Currency

group_itemobject

Subscription tiers grouped by Pool A / Pool B. The key is the group type: 10 Pool A, 20 Pool B, 0 ungrouped / other. When only group 0 exists, display the tiers as ungrouped.

borrowing_ratestring

Annual interest rate of broker financing (currency borrowing), for example "0.0575". Used to estimate the borrowing interest.

borrow_enableboolean

Whether currency borrowing (broker financing) is supported. When true, cash in other currencies converted at the exchange rate, stock collateral, and similar assets can be used as subscription principal.

min_subscribestring

Minimum number of shares to subscribe, used for US stock subscriptions. Empty string for HK stocks.

deduction_pricestring

Pre-deduction price, used for US stock subscriptions. Empty string for HK stocks.

available_card_countsinteger

Number of available benefit cards

card_typesarray<string>

Benefit card types supported by this IPO: ipo_interest IPO financing interest card, ipo_commission IPO fee card

frozen_ratiointeger

Frozen ratio of subscription funds (percentage), for example 120. When 0, Broker App displays it as 100.

same_kind_orderobject

The user's existing same-kind orders for this IPO, used to warn about duplicate subscriptions

Child attributes
stateinteger

Existing order status:

  • -1: No same-kind order (subscription allowed)
  • 0: A regular reservation order already exists
  • 1: An international placing reservation order already exists
  • 2: A subscription order already exists
Values
-1
0
1
2
account_channelstring

Tenant channel of the existing order. When it differs from the current tenant channel, remind the user that another account has already participated.

order_idinteger

Existing order id. 0 when there is no same-kind order.

docobject

Subscription page copy

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

declarationobject

Multilingual subscription declaration text. When not empty, the user must confirm it before submitting the subscription. May be null.

Child attributes
zh_cnstring

Simplified Chinese

zh_hkstring

Traditional Chinese

enstring

English

piinteger

Whether this IPO requires PI (Professional Investor) certification: 0 not required, 1 required

Values
0
1
pi_statusinteger

User PI certification restriction status:

  • 0: Unknown
  • 1: No PI restriction
  • 2: PI restriction applies and the user has not passed PI certification; guide the user to complete PI certification
  • 3: PI restriction applies and the user has passed PI certification
Values
0
1
2
3
aiinteger

Whether this IPO requires AI (Accredited Investor) certification: 0 not required, 1 required

Values
0
1
ai_statusinteger

User AI certification review status:

  • 0: Not submitted
  • 1: Pending review
  • 2: Approved
  • 3: Rejected
Values
0
1
2
3
certificationinteger

Certification type required by this IPO:

  • 0: No certification required
  • 1: PI certification
  • 2: AI certification
Values
0
1
2
min_cashstring

Minimum subscription amount for users without AI certification. When AI certification is required, the user has not passed it, and this value is greater than 0, guide the user to complete AI certification.

has_trade_permissionboolean

Whether the user has trading permission for this IPO. When false, the user is not allowed to enter the subscription page.

require_derivatives_knowledgeinteger

Whether a derivatives trading knowledge assessment is required: 0 not required, 1 required

Values
0
1
virtual_assetinteger

Virtual asset risk assessment requirement:

  • 0: Not required
  • 1: Confirmation only
  • 2: Questionnaire required
Values
0
1
2
vaetf_flagboolean

Whether the user already has virtual asset trading permission (has completed the virtual asset risk assessment)

Whale Docs