Skip to content
Longport WhaleLongport Whale
Cash

Clearing & Settlement - Cash Transaction Sync

Query the real-time account cash (balance) transaction synchronization records. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_account_balance_change_realtimes

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

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

Child attributes
aaidstring

Filters results by Client.

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