Skip to content
Market

Create Day-End Clearing Business Flow

Creates, edits, deletes, and reorders end-of-day clearing flows in one request. The request body is a flows array; each item carries its own action_in.

Request parameters

  • Required: flows. Each item requires flow_name, busin_no (execution order, starting from 1), and action_in (1 Add, 2 Delete, 3 Modify).
  • id: pass an empty string for a new flow; pass the existing flow ID to modify or delete it.
  • The Admin console sends every flow on the page in display order, with busin_no renumbered from 1.
  • Take the flow id from a row of POST /v1/datasets/clearing_busin_flows. Markets are bound to a flow through busin_flow_id in POST /clearing/markets, not through this endpoint.

Risk warning

This configuration changes the end-of-day clearing flows and their execution order. Confirm the flow list before calling.

Result

On success the flows are created, updated, or deleted as requested. Refer to the 200 response definition for returned data.

POSThttps://b-api.lbkrs.com/v2/clearing/create_busin_flow

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_edit

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

Request body application/json

flowsarray<object>required

List of end-of-day flows.

Child attributes
idstringrequired

Flow ID. Empty string for a new flow.

flow_namestringrequired

Flow name.

busin_nointegerrequired

Execution order of the flow, starting from 1.

action_instringrequired

Action for this flow.

Allowed values: 1 Add, 2 Delete, 3 Modify

Values
1
Add
2
Delete
3
Modify

Responses

HTTP 200The request was processed successfully. The frontend call site does not read fixed business fields from this endpoint's response, so only the general response structure (code, message, data) is declared here; the concrete fields inside data are unverified.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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