Manage Clearing Custodians

Creates, edits, and deletes clearing custodians through a single endpoint, distinguished by action_in.

Request parameters

Required: action_in (operation type).
Optional: id, name, name_zh, name_hk, ccass_code, address, email, tel, fax, main_flag (primary custodian), custodian_type, custodian_code, settle_type, contact_person, company_name, stamp_duty_file_no, seat_nos, settlement_channel, trading_account_type (sub-position derivation basis).
See the field definitions for format, value ranges, and business meaning.

Business notes

Use id to locate the target record when editing or deleting; omit id when adding.

Risk warning

This operation changes real custodian configuration and affects clearing and settlement. Confirm the target record and parameters before calling.

Result

On success the add, edit, or delete completes. Refer to the 200 response definition for returned data.

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

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 above, or the call will be rejected.

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

Allowed values: 1 Add, 2 Delete, 3 Edit

Values

1: Add
2: Delete
3: Edit

idstring

Custodian ID associated with this request.

namestring

name_zhstring

name_hkstring

ccass_codestring

addressstring

emailstring

telstring

faxstring

main_flagstring

Whether this is the main service provider.

Allowed values: 1 Yes (main service provider), 0 No

Values

1: Yes (main service provider)
0: No

custodian_typestring

Specifies Custodian Type.

Allowed values: 1 Agent/custodian, 2 Agent, 3 Custodian

Values

1: Agent custodian.
2: Agent.
3: Custodian

custodian_codestring

settle_typestring

settle_type. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

contact_personstring

company_namestring

stamp_duty_file_nostring

Specifies Stamp Duty File No..

seat_nosstring

settlement_channelstring

trading_account_typestring

trading_account_type. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

Responses

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