Skip to content
Longport WhaleLongport Whale
Cash

Account Cash Balance Unfreeze Debit

Unfreezes previously frozen cash on a securities account and debits it directly, instead of releasing it back to the available balance.

Request parameters

  • Required: account_no (securities account), serial_num (original freeze serial number).
  • Optional: request_id (idempotency key), biz_code (business code).
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

Directly deducts the frozen funds identified by the original freeze serial_num. Suitable when the business is finalized and the frozen funds must be consumed directly. Unlike the unfreeze endpoint, the funds are not returned to the available balance. Use request_id for idempotency.

Risk warning

This operation directly deducts real account funds. Confirm the account and serial number before calling.

Result

On success, the unfreeze-and-debit completes. Refer to the 200 response definition for the resulting state.

POSThttps://b-api.lbkrs.com/v1/whaleapi/asset/unfrozen_debit

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance_unlock.cash_query

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.

serial_numstringrequired

Serial Number. Serial Number

request_idstring

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

biz_codestring

Business Code. Business Code

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
msgstringrequired

Message. Message

serial_numstring

Serial No. Serial No

error_codestringrequired

Error Code. Error 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