Corp Action Management

Void Client Register Details

Voids client register details under a corporate action in batch.

The caller must provide ids, the list of register-detail IDs (client detail records) to void. The system marks those details as voided.

Request parameters

Required: ids (list of register-detail IDs)
Optional: audit_frontend_resource (caller-provided audit context)

Result

On success, the specified register details are voided and the result is returned in data. Interpret the outcome together with the business code.

POSThttps://b-api.longbridge.xyz/v1/delete/register/details

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idsarray<string>required

List of client register-detail IDs to void. Each item identifies one client detail record.

audit_frontend_resourceobject

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

Child attributes

ca_codestring

Associated corporate-action announcement number.

origin_counter_idstring

Associated security identifier.

aaidstring

Associated client account 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/delete/register/details' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "ids": [
    "1001",
    "1002"
  ],
  "audit_frontend_resource": {
    "ca_code": 882902308,
    "origin_counter_id": "ETF/US/DIPS",
    "aaid": "20000012345"
  }
}'

Response

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