Get IPO Subscription Record Details

GEThttps://api.lbkrs.com/v1/ipo/detail

Parameters

order_idstringqueryRequired

Subscription order id, taken from data.orders[].id in the subscription record list

modifybooleanquery

Whether this is a subscription modification scenario. Pass true when loading the original order to modify a subscription; the returned buy_limit is used as the buying power for the modification.

account_channelstringquery

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get IPO subscription record details” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

idstring

Subscription order id

namestring

Stock name

codestring

Stock code

marketstring

Market, for example HK or US

counter_idstring

Stock id, such as ST/HK/9988

currencystring

Subscription currency

ipo_pricestring

Issue price

sub_qtystring

Number of shares subscribed

sub_amountstring

Subscription amount

sub_feestring

Subscription handling fee

lot_win_qtystring

Number of shares allotted

statusinteger

Order status:

1: Pending deduction (funds frozen)
2: Deduction failed
3: Deducted (allotment results pending)
4: Announced (allotted)
5: Announced (not allotted)
6: Cancelled by user
7: Listing withdrawn (subscription cancelled)
8: Rejected

Values

1
2
3
4
5
6
7
8

reject_textstring

Rejection reason, displayed when status is 8

ipo_statusinteger

IPO status:

0: Normal
1: Listing postponed
2: Listing canceled

Values

0
1
2

methodinteger

Subscription method:

1: Financed subscription
2: Cash subscription
3: HK channel financed subscription (bank financing)
4: International placing
5: Zero-principal subscription
6: Dynamic financing

Values

1
2
3
4
5
6

multiplestring

Financing multiple (such as 10 or 20). When greater than 1, the financing multiple label is displayed.

markinteger

Order type:

0: Regular order
1: Reservation order
2: International placing order

Values

0
1
2

batch_idstring

Financing batch id (VIP batch), passed back as is when modifying a subscription

channelstring

Financing channel

account_channelstring

Broker channel

withdrawableboolean

Whether the subscription can be cancelled. When true, the "Cancel subscription" button is displayed.

modify_enableboolean

Whether the subscription can be modified. When true, the "Modify subscription" button is displayed.

borrow_enableboolean

Whether broker financing (currency borrowing) is supported. When true, the broker financing amount is displayed.

timelinearray<object>

Subscription progress timeline nodes

Child attributes

namestring

Node name

lightboolean

Whether the node is highlighted (reached)

timestring

Node time (display text)

descstring

Node description

current_amountstring

Cash amount in the current currency used for the subscription (such as HKD withdrawable / USD cash)

financing_amountstring

Financing amount (bank financing portion)

financing_intereststring

Financing interest

finance_fee_ratestring

Financing interest rate

borrow_amountstring

Broker financing (currency borrowing) amount

borrow_intereststring

Broker financing (currency borrowing) interest. When no financing interest card is used, the displayed financing interest = financing_interest + borrow_interest

total_amountstring

Total amount

need_to_paystring

Amount to top up. When not 0, a top-up notice is displayed.

explanationstring

Top-up explanation text, displayed in a pop-up when the top-up notice is tapped

refund_amountstring

Amount to refund. When not 0, a refund notice is displayed.

lucky_feestring

Allotment fee, displayed when greater than 0

luck_atstring

Allotment announcement time, timestamp (in seconds)

ipo_datestring

Listing time, timestamp (in seconds)

mart_beginstring

Grey market start time, timestamp (in seconds)

mart_endstring

Grey market end time, timestamp (in seconds)

cardsarray<object>

Deduction details of the benefit cards used for this subscription

Child attributes

card_idstring

Card id

card_typestring

Card/voucher type:

cash: Cash card
quote: Quote card
fundamental: Fundamentals card
commission: Commission-free card
ipo: IPO privilege card
ipo_interest: IPO financing interest card
ipo_commission: IPO fee card

Values

cash
quote
fundamental
commission
ipo
ipo_interest
ipo_commission

statusinteger

Card usage status:

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

Values

0
1
2
3

origin_amountstring

Amount before deduction (original financing interest or original handling fee)

delta_amountstring

Fee after deduction

bz_typesarray<integer>

Business type: 1 financed IPO subscription, 2 cash IPO subscription

using_cardarray<object>

Information about the benefit card used for this subscription, used to prefill the selected card/voucher when modifying the subscription

Child attributes

card_idstring

Card id

card_typestring

Card/voucher type; same values as cards[].card_type

titlestring

Card/voucher title

title_secstring

Card/voucher subtitle

member_idstring

Holder id

coverstring

Cover image

descriptionstring

Card/voucher description

detailstring

Card/voucher details

backgroundstring

Card/voucher background image

stylestring

Style

start_timestring

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

end_timestring

Expiration time, timestamp (in seconds)

activate_timestring

Card/voucher activation time, timestamp (in seconds)

card_statusinteger

Card/voucher status:

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

Values

0
1
2
3

currencystring

Currency unit, applicable to cash cards, commission-free cards, IPO financing interest cards, and IPO fee cards

amountstring

Associated amount

invisibleboolean

Whether the card is hidden

cashobject

Cash card attributes

Child attributes

receive_durationstring

Time required for the cash to arrive, in seconds

quoteobject

Quote card attributes

Child attributes

quote_tagsarray<string>

Benefit labels

quote_durationstring

Permission duration, in seconds

fundamentalobject

Fundamentals card attributes; same structure as quote

Child attributes

quote_tagsarray<string>

Benefit labels

quote_durationstring

Permission duration, in seconds

commissionobject

Commission-free card attributes

Child attributes

marketsarray<string>

Commission-free market, such as US, HK, SH, or SG

rebate_ratestring

Commission waiver ratio; 1 means 100%

bz_typesarray<integer>

Business type: 0 stocks, 1 financed IPO subscription, 2 cash IPO subscription

commission_durationstring

Commission-free card duration, in seconds

commission_balancestring

Commission-free card balance

unlimitedinteger

Unlimited quota type: 1 unlimited quota - commission rebate, 2 unlimited quota - direct deduction

commission_expired_timestring

Commission-free expiration time (for a commission-free card in use), timestamp (in seconds)

ipoobject

IPO privilege card attributes

Child attributes

subscription_idstring

Reservation id. Empty means a general-purpose IPO card.

ipo_interestobject

IPO financing interest card attributes

Child attributes

discount_ratestring

Interest subsidy rate; 1 means 100%

ipo_commissionobject

IPO fee card attributes

Child attributes

bz_typesarray<integer>

Business type: 1 financed IPO subscription, 2 cash IPO subscription

financing_limitstring

Minimum amount threshold for financed IPO subscription; 0 means no threshold

counter_idstring

Designated stock id. Empty means no restriction.

stockobject

Stock card attributes

Child attributes

counter_idstring

Stock id

amountinteger

Number of shares granted

stock_fragmentobject

Fractional share card attributes

Child attributes

counter_idstring

Stock id. Empty means a general-purpose fractional share card.

marketstring

Applicable market of the fractional share card

buy_limitobject

Buying power information. When modify=true, it is the available buying power for modifying the subscription.

Child attributes

total_amountstring

Total buying power (for display)

current_amountstring

Cash in the current currency (such as HKD withdrawable)

mmf_amountstring

Money market fund (MMF) amount

cash_amountstring

Cash amount

cash_withdrawstring

Buying power used when the financing base type is cash

ipo_buy_limitstring

IPO buying power used when the financing base type is buying power

docobject

Subscription-related explanation texts

Child attributes

subscription_methodstring

Subscription method explanation

buying_powerstring

IPO buying power explanation

financing_intereststring

Financing interest explanation, displayed in a pop-up when the financing interest info icon is tapped

cut_off_timestring

Subscription deadline explanation

financing_estimatestring

Financing estimate explanation

noticestring

Reminder

subscription_statementstring

Subscription statement

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.

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v1/ipo/detail"
)
request.query = [
    "order_id": "<ORDER_ID>"
]

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

Response Example

{
  "code": 400,
  "message": "Subscription information not found",
  "data": null
}