Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Get In-Progress Flow Ticket Info

Returns the in-progress ticket for a given corporate action.

Request parameters

  • Required: ann_id (corporate-action ID), flow_ticket_type (ticket type).
  • Pass 1 (announcement type) when querying the ticket for executing or revoking a corporate action; pass 2 (tax-refund type) when querying the ticket for a tax refund or its revocation.

Returns

On success returns the ticket ID in data.flow_ticket_id, which the caller can use to open the corresponding ticket.

POSThttps://b-api.lbkrs.com/corporate_action/flow_ticket/info

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

ann_idstringrequired

Corporate action ID identifying the corporate action whose flow ticket is queried.

flow_ticket_typeintegerrequired

Flow ticket type.

Allowed values: 0 Unspecified (invalid value), 1 Announcement (used for execute and revoke), 2 Refund (used for tax refund and revoke tax refund)

Values
0
Unspecified
1
Announcement
2
Refund

Responses

HTTP 200The request was processed successfully. The flow-ticket information is returned in data.flow_ticket_id.
Standard response envelopecodemessagedata
dataobjectdata structure
flow_ticket_idnumberrequired

Returned value: ID in the flow-ticket system; use it to open the corresponding flow-ticket page.

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