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.longbridge.xyz/clearing/custodians

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

Allowed values:

1 - Add
2 - Delete
3 - Edit

1 · Add2 · Delete3 · Edit

idstring

Custodian ID associated with this request.

namestring

Specifies Name.

name_zhstring

Specifies Name (ZH).

name_hkstring

Specifies Name (HK).

ccass_codestring

Specifies CCASS Code.

addressstring

Specifies Address.

emailstring

Specifies Email.

telstring

Specifies Tel.

faxstring

Specifies Fax.

main_flagstring

Specifies Main Flag.

custodian_typestring

Specifies Custodian Type.

Allowed values:

1 - Agent custodian.
2 - Agent.
3 - Custodian

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

custodian_codestring

Specifies Custodian Code.

settle_typestring

Specifies Settle Type.

contact_personstring

Specifies Contact Person.

company_namestring

Specifies Company Name.

stamp_duty_file_nostring

Specifies Stamp Duty File No..

seat_nosstring

Specifies Seat Nos.

settlement_channelstring

Specifies Settlement Channel.

trading_account_typestring

Specifies Trading Account Type.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.