Create / Edit / Delete Account-level Settlement Instruction Rule

Create, edit, and delete of an account-level settlement instruction rule share one endpoint, distinguished by action_in (1 = add, 2 = delete, 3 = modify). Unlike market-level rules, this endpoint configures settlement rules for a specific client account (aaid).

Request parameters

Required: action_in (Action 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 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.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/clearing/account_instruction_settings

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

action_instringrequired

Specifies the action to perform. This field is required.

Allowed values:

1 - Add
2 - Delete
3 - Modify

1 · Add2 · Delete3 · 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 client securities account the rule applies to.

marketstring

Specifies the market.

settlement_channelstring

Specifies the settlement channel.

stagestring

Specifies the trade stage.

biz_typestring

Specifies the business type.

directionstring

Specifies the buy/sell direction.

positionstring

Specifies the position side (long/short).

instr_typestring

Specifies the instruction type.

settle_methodstring

Specifies the settlement method.

custodian_idstring

Specifies the default custodian.

sub_position_nostring

Specifies the default sub-account.

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.