Skip to content
Data Service Provider

Manage Clearing Custodians

Manages Clearing Custodians.

Request parameters

  • Required: action_in (Action In)
  • Optional: id (Custodian ID), name (Name), name_zh (Name (ZH)), name_hk (Name (HK)), ccass_code (CCASS Code), address (Address), email (Email), tel (Tel), fax (Fax), main_flag (Main Flag), custodian_type (Custodian Type), custodian_code (Custodian Code), settle_type (Settle Type), contact_person (Contact Person), company_name (Company Name), stamp_duty_file_no (Stamp Duty File No.), seat_nos (Seat Nos), settlement_channel (Settlement Channel), trading_account_type (Trading Account Type)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.lbkrs.com/clearing/custodians

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_custodians

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

1 · Add2 · Delete3 · Edit

idstring

Custodian ID associated with this request.

namestring
name_zhstring
name_hkstring
ccass_codestring
addressstring
emailstring
telstring
faxstring
main_flagstring
custodian_typestring

Specifies Custodian Type.

1 · Agent custodian.2 · Agent.3 · Custodian

custodian_codestring
settle_typestring
contact_personstring
company_namestring
stamp_duty_file_nostring

Specifies Stamp Duty File No..

seat_nosstring
settlement_channelstring
trading_account_typestring

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
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