Skip to content
Market

Create / Edit / Delete Account-level Settlement Instruction Rule

Creates, edits, and deletes account-level settlement rules through a single endpoint, distinguished by action_in (1 = add, 2 = delete, 3 = modify). Unlike market-level settlement rules, this endpoint configures rules per specific client account (aaid).

Request parameters

  • Required: action_in (operation type).
  • Add (action_in=1): submit the client account aaid, the rule-dimension fields (market, settlement_channel, stage, 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.

Business notes

Account-level rules take precedence over market-level rules and let callers assign a settlement path to a specific client account.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_account_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 account-level settlement instruction rule record. May be omitted on add; required on edit or delete to target an existing record.

aaidstring

Specifies the customer securities account that the rule belongs to.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

marketstring
settlement_channelstring
stagestring
biz_typestring

biz_type.

Allowed values: 1 Stock, 5 Option

Values
1
Stock
5
Option
directionstring

direction.

Allowed values: 1 Buy, 2 Sell

Values
1
Buy
2
Sell
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.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs