Skip to content
Corp Action Management

Check Transfer Pending

Checks whether there are in-progress transfer records under the specified announcement. Call this endpoint before executing a corporate action; if in-progress transfer records exist, the caller can warn the operator or block the subsequent execution.

Request parameters

  • Required: ann_id (announcement ID)
  • See each field for its format, allowed values, and business meaning.

Response

On success, returns the list of in-progress transfer conflict records under the announcement in data.items. An empty list means there are no in-progress transfer records.

POSThttps://b-api.longbridge.xyz/v1/check_transfer

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

ann_idstringrequired

Unique identifier of the announcement to check. This field is required.

Responses

HTTP 200The request was processed successfully. The result is in data.items, the list of in-progress transfer conflict records under the announcement.
Standard response envelopecodemessagedata
dataobjectdata structure
itemsarray<object>

Returned value: List of in-progress transfer conflict records under the announcement. An empty list means there are no in-progress transfer records.

Child attributes
record_idstring

Returned value: Unique identifier of the transfer record.

aaidstring

Returned value: Account AAID.

account_nostring

Returned value: Account number.

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