Skip to content
Longport WhaleLongport Whale
Corp Action Management

Order Subscribe (Rights Offer Subscription)

Submits a subscription for a client against a corporate-action advance notice (the subscription filing in a rights-offer scenario).

Request parameters

  • Required: aaid (client account), ann_id (advance-notice ID), quantity (subscription quantity).
  • See the field descriptions for the format, allowed values, and business meaning of each field.

Risk warning

This operation submits a subscription on the client's behalf and involves their real entitlement and funds. Confirm the account, advance notice, and quantity before calling.

Result

On success the subscription is submitted for the client at the given quantity; the outcome is in data. Interpret it together with the business code.

POSThttps://b-api.lbkrs.com/v1/order/subscribe

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

aaidstringrequired

Identifier of the client account submitting the subscription.

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_idstringrequired

Unique identifier of the corporate-action announcement.

quantitystringrequired

Quantity to subscribe for in this request.

Responses

HTTP 200The request was processed successfully. The result is returned in data.
Standard response envelopecodemessagedata
dataobjectdata structure

Business result; usually an empty object.

No nested fields

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