Skip to content
Longport WhaleLongport Whale
Cash

Account Cash Balance Freeze

Freezes cash on a securities account, locking the amount out of the available balance.

Request parameters

  • Required: account_no (securities account), currency, frozen_amount (amount to freeze), biz_code (business code).
  • Optional: remark, request_id (idempotency key), require_risk_check (whether to run risk control).
  • biz_code values come from the business-code dictionary.
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

Locks the specified amount out of the available balance and returns a transaction serial number serial_num on success. Frozen funds must be handled later via the unfreeze or unfreeze-and-debit endpoints. Use require_risk_check for risk control and request_id for idempotency.

Risk warning

This operation locks real account funds. Confirm the account, currency, and amount before calling.

Result

On success, the cash is frozen and serial_num is returned. Refer to the 200 response definition for the resulting state.

POSThttps://b-api.lbkrs.com/v2/whaleapi/asset/frozen_cash

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance_lock.cash

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

Request body application/json

account_nostringrequired

Account NO Eg:L6VQEU00121996. 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.

currencystringrequired

Currency Eg:HKD. Currency Eg:HKD

frozen_amountstringrequired

Frozen Amount. Frozen Amount

remarkstring

Remark. Remark

biz_codestringrequired

Business Code. Business Code

serial_numstring

Serial Number. Serial Number

request_idstring

Idempotency ID ,keep Global Unique. Idempotency ID ,keep Global Unique

require_risk_checkboolean

Need Risk Check. Need Risk Check

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
msgstringrequired

msg

serial_numstringrequired

Serial Number. Serial Number

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