Skip to content
HK IPO

IPO Delisting Action

Marks a specified IPO security as delisted (cancelled listing) and applies handling actions to the related subscription orders.

Request parameters

  • Required: counter_id (security ID)
  • Optional: account_channel, status (order status), actions (handling action list)
  • See each field description for its format, value range, and business meaning.

Business notes

The listing is cancelled for the security identified by counter_id. account_channel and status can narrow the scope, and actions specifies the follow-up handling of the related orders.

Risk warning

This operation cancels an IPO listing and triggers handling of customers' subscription orders, which may change funds and order status. Verify the target security and handling actions before calling.

Result

On success, returns whether the operation completed.

POSThttps://b-api.lbkrs.com/ipo/delisting

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

ipo.ipo_delist

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

counter_idstringrequired

Counter ID. This field is required. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

account_channelstring

Account Channel.

statusinteger

Status. Order status.

Allowed values: 1 Pending deduction (funds frozen), 3 Deducted (allotment result pending), 4 Announced (allotted), 5 Announced (not allotted)

Values
1
3
4
5
actionsarray<string>

Actions.

Responses

HTTP 200The request was processed successfully. data.done indicates whether the action completed.
Standard response envelopecodemessagedata
dataobjectdata structure
doneboolean

Done.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs