Check Adjustment Revocable

Manual-adjustment revoke validation: shared across the eight asset types (Cash/Stock/Fund/Option/Bond/OTC Other/Cryptocurrency/OTC Derivatives). When "Revoke" is clicked it first checks whether the adjustment can be revoked (e.g. it cannot if the funds have since been used).

Request parameters

Required: id (Adjustment Ticket ID)
See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/v1/risk_event/settlement_revoke_check

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Adjustment Ticket ID associated with this request.

Responses

HTTP 200The request was processed successfully. data contains revoke_type.

Standard response envelopecodemessagedata

dataobjectdata structure

revoke_typestring

Allowed Revoke Type. Determines which option in the "Revoke reason" single-select is available; values come from the dawn_undo_adjustment_revoke_type dynamic enumeration and are not fixed.

Allowed values:

REGULAR_REVOCATION - Regular Revocation
UNTRACEABLE_REVOCATION - Untraceable Revocation

Call GET /v1/datasets/refs/dawn_undo_adjustment_revoke_type to retrieve the current data dictionary, and use the returned entry's key as this field's value.

REGULAR_REVOCATIONUNTRACEABLE_REVOCATION

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/risk_event/settlement_revoke_check' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "id": 123
}'

Response

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