Skip to content
Account Transfers

Query Transferable Cash Amount

Returns the maximum transferable amount in each currency when moving cash from the source account to the destination account. The cash transfer form uses it to show the maximum amount after the Client selects both accounts and a currency, and to validate the entered amount. Transfers between a Client's main account and sub-accounts, and between a cash account and a margin account, both use this operation.

The Broker App picks the list item that matches the selected currency. The entered amount must not exceed max_transfer_balance. For a transfer from the main account to a sub-account, if the amount exceeds withdraw, tell the Client that the part above the withdrawable cash may incur interest.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/app/risk_event_api/query_cash_transfer_balance

Parameters

from_aaidstringqueryRequired

aaid of the source account

to_aaidstringqueryRequired

aaid of the destination account

is_enable_dynamic_calculate_modebooleanquery

Whether to enable dynamic calculation mode. The Broker App always sends true

Responses

HTTP 200The request succeeded. The response body contains the result of the “Query Transferable Cash Amount” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Transferable amount by currency

Child attributes
currencystring

Currency, such as HKD

max_transfer_balancestring

Maximum transferable amount in this currency, as a decimal string

withdrawstring

Withdrawable cash in this currency, as a decimal string

total_available_cashstring

Total available cash of the source account, as a decimal string

Whale Docs