Skip to content
Longport WhaleLongport Whale
Cash

Account Cash Balance Unfreeze

Unfreezes previously frozen cash on a securities account, releasing the funds back to the available balance.

Request parameters

  • Required: account_no (securities account), currency, unfrozen_amount (amount to unfreeze), biz_code (business code), serial_num (original freeze serial number).
  • Optional: remark, request_id (idempotency key).
  • 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

Unfreezes the corresponding amount identified by the original freeze serial_num, releasing the frozen funds back to the available balance.

Risk warning

This operation releases real frozen account funds. Confirm the account, serial number, and amount before calling.

Result

On success, the cash is unfrozen. Refer to the 200 response definition for the resulting state.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance_unlock.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

unfrozen_amountstringrequired

Unfrozen Amount. Unfrozen Amount

remarkstring

Remark. Remark

biz_codestringrequired

Business Code. Business Code

serial_numstringrequired

Serial Number. Serial Number

request_idstring

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

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