Skip to content
Longport WhaleLongport Whale
VA Clearing

Trigger VA Clearing

Starts the virtual-asset clearing workflow for a given business date.

Request parameters

  • Required: biz_date (business date)
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

The clearing workflow runs against biz_date as its clearing cycle; once triggered, the system clears the data for that business date.

Risk warning

This operation triggers a real clearing workflow that affects related funds and accounting. Confirm biz_date is correct before calling.

Result

On success, the clearing workflow is triggered. The resulting status and returned data are defined by the 200 response.

POSThttps://b-api.lbkrs.com/billing/va/trigger

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.billing_va_contracts

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

Request body application/json

biz_datestringrequired

Business Date. Business Date associated with this request. Use the date format defined by the API. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
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