Corp Action Management

Revoke Client Rights-Offer Order

Revokes (voids) a client's rights-offer subscription order.

The caller must provide order_id, the ID of the order to void. The system cancels that order.

Request parameters

Required: order_id (order ID)
Optional: audit_frontend_resource (caller-provided audit context)

Result

On success, the specified order is revoked and the result is returned in data. Interpret the outcome together with the business code.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

order_idstringrequired

Unique identifier of the rights-offer subscription order to void.

audit_frontend_resourceobject

Caller-provided audit context recording the business information associated with this operation. Typically includes the security, announcement number, and origin identifier.

Child attributes

origin_counter_idstring

Associated security identifier.

ca_codestring

Associated corporate-action announcement number.

origin_idstring

Associated origin record identifier.

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/order/revoke' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "order_id": "300012345",
  "audit_frontend_resource": {
    "origin_counter_id": "ETF/US/DIPS",
    "ca_code": 882902308,
    "origin_id": "117456"
  }
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {}
}