Skip to content
Longport WhaleLongport Whale
Cash

Clearing & Settlement - Cash Transaction Sync

Query account cash-balance change ledger entries synced in real time during clearing and settlement, used by the clearing team to reconcile each increase or decrease in cash balance and trace its business origin.

Request parameters

  • Combine business filters through filters (optional fields are listed under the filters field notes below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from balance-change records synced in real time on the clearing side; each entry corresponds to one accounting change to an account's cash balance.

Every record carries the customer securities account (aaid) and account name, currency (currency), business code (biz_code, such as cash deposit), ledger amount (ledger_amount), ledger date (ledger_date) and event time (created_at), along with the related order id, serial number, and remarks.

It is commonly used for cash reconciliation during day-end clearing, investigation of exception adjustments (operability), and tracing the source of balance changes by customer, currency, or business type.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_account_balance_change_realtimes

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clear_account_balance_changes

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
aaidstring

Filters results by Client.

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.

currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

biz_codestring

Filters results by Biz Code.

created_atobject

Filters results by Created At.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

ledger_dateobject

Filters results by Ledger Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing Settlement - Cash Transaction Sync records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

origin_idstring

Returned value: A/C No..

currencystring

Returned value: Currency.

biz_codestring

Returned value: Biz Code.

biz_code_valstring

Raw value of biz_code. The biz_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ledger_amountstring

Returned value: Amount.

remarkstring

Returned value: EN Remark.

remark_cnstring

Returned value: CN Remark.

remark_hkstring

Returned value: TN Remark.

op_remarkstring

Returned value: EN Inner Remark.

op_remark_cnstring

Returned value: CN Inner Remark.

op_remark_hkstring

Returned value: TN Inner Remark.

serial_nostring

Returned value: Serial No.

operabilitystring

Returned value: Edit Location.

operability_valstring

Raw value of operability. The operability field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created At. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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