Create / Edit / Delete Settlement Instruction Rule

Create, edit, and delete of a settlement instruction rule share one endpoint, distinguished by action_in (1 = add, 2 = delete, 3 = modify).

Required: action_in (Action 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 existing record id together with the fields to update.
Delete (action_in=2): pass only id and action_in; the request body looks like { id, action_in: "2", audit_frontend_resource }.
See each field for its allowed values and business meaning.

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/instruction_settings

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

Authorization

AuthorizationstringheaderRequired

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

lb_hk_clearing.clearing_instruction_settings

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

action_instringrequired

Specifies the action to perform. This field is required.

1 · Add2 · Delete3 · 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

biz_typestring

directionstring

positionstring

instr_typestring

settle_methodstring

custodian_idstring

sub_position_nostring

audit_frontend_resourceobject

Provides audit context for this operation.

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