Skip to content
Corp Action Management

corporate subscribe orders

Query client subscription orders generated by corporate actions (such as rights issues or open offers that require subscription), used for subscription-order reconciliation and management.

Request parameters

  • Combine business filters through filters (available fields are listed under the filters field docs), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data comes from corporate-action subscription-order records, filterable by aaid (client AAID) and ann_id (announcement ID).

Each record is a client's subscription order under one option, carrying the event ID, application price, elected application quantity, expected allotted quantity, total holding quantity, order state, initiator (App or back office), estimated application amount and fees, plus locked amount/quantity/fee and creation and update times.

Typically used to reconcile a client's subscribed quantity and amount, fees, and locked funds.

Returns

On success, returns the matched record list with pagination info. See the response definitions for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_subscribe_orders

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

filtersobject

Filters

Child attributes
aaidstring

Aaid

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

ann_idstring

Ann Id

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
event_idstring

Event Id

exchange_pricestring

Exchange Price

choices_quantitystring

Choices Quantity

subscribe_quantitystring

Subscribe Quantity

origin_quantitystring

Origin Quantity

statestring

State

created_atstring

Created At

updated_atstring

Updated At

operate_typestring

Operate Type

idstring

Id

subscribe_amountstring

Subscribe Amount

other_fee_amountstring

Other Fee Amount

handing_fee_amountstring

Handing Fee Amount

locked_amountstring

Locked Amount

locked_quantitystring

Locked Quantity

locked_feestring

Locked Fee

totalintegerrequired

Total

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