Create / Edit / Delete Settlement Channel Mapping

Creates, edits, and deletes settlement-channel mappings through a single endpoint, distinguished by action_in.

Request parameters

Required: action_in (operation type).
Optional: id, custodian_id (agent ID), settlement_channel, channel_type (trade type), tolerance_threshold (reconciliation tolerance), account_mode (seat-number filter), verify_accounts (seat numbers), verified (trade reconciliation mode), remark, audit_frontend_resource (audit context).
See the field definitions for format, value ranges, and business meaning.

Business notes

Add (action_in=1): omit id and submit the mapping's business fields.
Edit (action_in=3): pass the target record's id together with the fields to update.
Delete (action_in=2): pass only the target record's id and audit_frontend_resource.

Risk warning

This operation changes real settlement-channel mappings and reconciliation configuration and affects fund reconciliation results. 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/settlement_channels

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_settlement_channels

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

Settlement channel mapping record ID that identifies the target of this request. Required when editing or deleting.

custodian_idstring

Specifies Broker ID, identifying the broker that owns the settlement channel mapping.

channel_typestring

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

tolerance_thresholdstring

Channel amount tolerance threshold. Allowed range [0, 1000]; a default of 0 means the tolerance is disabled.

account_modestring

Seat number filter mode.

Allowed values: 0 None (no seat filter), 1 Include, 2 Exclude

Values

0: None (no seat filter)
1: Included seats
2: Excluded seats

remarkstring

audit_frontend_resourcestring

Caller-provided audit context used for operation audit logging. The delete operation submits this field together with the request body.

match_typestring

Reconciliation match mode; options come from a backend data dictionary

accountsstring

Seat/account numbers

Responses

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