Skip to content
Longport WhaleLongport Whale
Cash

Account Cash Freeze Transaction History

Returns the cash freeze/unfreeze flow records for a securities account.

Request parameters

  • This endpoint has no required parameters; see the field definitions for optional parameters.
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Filter by account_no, currency currency, freeze status frozen_status, and time range. Combined with the pagination parameters, it returns the matching freeze-flow list; each record includes the freeze type (freeze or unfreeze), amount change, flow time, and business code.

Returns

On success, returns the cash freeze-flow list with pagination info. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/asset/financial_frozen_flows

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance_lock.cash_query

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

Parameters

account_nostringRequired

Account NO Eg:L6VQEU00121996

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

frozen_statusstring

Frozen Status 0 - All 1 - frozee 2 - unfrozee Eg:0

currencystring

Currency Eg:HKD

start_timestring

Start Time

end_timestring

End Time

pagestring

Page

sizestring

The Number Of Page Size

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
frozen_flows_listarray<object>required

Frozen Transaction History List. Frozen Transaction History List

Child attributes
flow_namestringrequired

Transaction Name. Transaction Name

amountstringrequired

Frozen/UnFrozen Amount. Frozen/UnFrozen Amount

currencystringrequired

Currency. Currency

bussiness_timestringrequired

Business Time. Business Time

serial_numstringrequired

Serial Number. Serial Number

frozen_typenumberrequired

Frozen Type. Frozen Type

bussiness_codestringrequired

Business Code. Business Code

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