Skip to content
Longport WhaleLongport Whale
Day-End Tasks

Before Clearing Ready Check

Run pre-clearing readiness, checking whether the specified workflow is ready to start clearing for the current ledger date.

Request parameters

  • Required: ledger_date (ledger date, format YYYYMMDD), busin_no (workflow number)
  • Optional: audit_frontend_resource (audit context)
  • See each field's description for format, value range, and business meaning.

Risk warning

This operation affects market-wide end-of-day settlement or the settlement cutoff time and carries very high risk. Verify the ledger date, market scope, and action type, and ensure proper authorization before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/clearing/before_clearing_ready

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_exec

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

Request body application/json

ledger_datenumberrequired

This field is required.

Pass the clearing ledger date: the ledger_date returned by get_near_three_ledger_date. Do not use get_current_ledgedate; it returns the front-office ledger date, which may already be ahead of clearing, and calling with it returns 800008 (dependent task not finished).

busin_nonumberrequired

Specifies Business No.. This field is required.

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
itemsarray<object>
Child attributes
item_codestring
item_namestring
statusinteger

Status

descriptionstring

Description

suggestionstring

Suggestion

item_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