Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Get In-Progress Flow Ticket Info

Gets the in-progress flow-ticket information of a given corporate action.

Request parameters

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

Response

On success, the flow-ticket ID is returned in data.flow_ticket_id, which the caller can use to open the corresponding flow-ticket page.

POSThttps://b-api.longbridge.xyz/corporate_action/flow_ticket/info

Authorization

AuthorizationstringheaderRequired

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

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 (an abnormal value; not used in normal calls)
  • 1 - Announcement; used when querying the flow ticket for executing or revoking a corporate action
  • 2 - Refund; used when querying the flow ticket for tax refund or refund revocation

0 · Unspecified1 · Announcement2 · 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