Create / Edit / Delete Settlement Instruction Rule

Creates, edits, and deletes market-level settlement rules through a single endpoint, distinguished by action_in (1 = add, 2 = delete, 3 = modify).

Request parameters

Required: action_in (operation type).
Add (action_in=1): submit the rule-dimension fields (market, settlement_channel, stage, account_type, biz_type, direction, position, instr_type, settle_method) and the default settlement config (custodian_id, sub_position_no); id may be omitted.
Edit (action_in=3): pass the target record's id and submit the fields to update.
Delete (action_in=2): pass only id, action_in, and audit_frontend_resource (audit context).
See the field definitions for value ranges and business meaning.

Risk warning

This operation changes real settlement-rule configuration and affects downstream clearing and settlement routing. 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/instruction_settings

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_instruction_settings

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

Request body application/json

action_instringrequired

Specifies the action to perform. This field is required.

Allowed values: 1 Add, 2 Delete, 3 Modify

Values

1: Add
2: Delete
3: Modify

idstring

ID of the settlement instruction rule record. May be omitted on add; required on edit or delete to target an existing record.

marketstring

settlement_channelstring

stagestring

account_typestring

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

biz_typestring

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

directionstring

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

positionstring

instr_typestring

instr_type.

Allowed values: A ATI, T STI, S SI, I ISI

Values

A: ATI
T: STI
S: SI
I: ISI

settle_methodstring

settle_method.

Allowed values: F FOP, D DVP, R RDP

Values

F: FOP
D: DVP
R: RDP

custodian_idstring

sub_position_nostring

audit_frontend_resourceobject

Provides audit context for this operation.

Responses

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