Skip to content
Longport WhaleLongport Whale
Corp Action Management

Order Subscribe (Rights Offer Subscription)

Submits a subscription for a client against a corporate-action announcement (the subscription application in a rights-offer scenario).

The caller must provide the client account aaid, the announcement ID ann_id, and the subscription quantity quantity.

Request parameters

  • Required: aaid (client account), ann_id (announcement ID), quantity (subscription quantity)

Result

On success, the subscription is submitted for the client with the specified quantity and the result is returned in data. Interpret the outcome together with the business code.

POSThttps://b-api.longbridge.xyz/v1/order/subscribe

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

aaidstringrequired

Identifier of the client account submitting the subscription.

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