Skip to content
Fund Trading

Get Fund Purchasing Power

Returns the Client's purchasing power for subscribing to a fund in the given currency: the amount directly usable in that currency, the maximum purchasable amount, and cash details by currency. Call it with the currency from Get Fund Order Page Information after the subscription page loads, and call it again when the Client returns from a page such as currency exchange. The maximum subscription amount is limit_amount ÷ (1 + subscription fee rate). Also used to check whether the installment amount exceeds available cash when creating a recurring investment plan.

When you call this endpoint through WhaleCore requestService(), set requiresTradeToken to true.

GEThttps://api.lbkrs.com/ut/withdraw/cash

Parameters

currencystringqueryRequired

Payment currency. Use the currency returned by Get Fund Order Page Information

counter_idstringquery

Fund ID (counter_id), a fund code in the form UT/HK/...

x-target-aaidstringheader

The aaid of the target fund account. Broker App passes the fund account the Client currently selects

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get fund purchasing power” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
current_amountnumber

Available cash in the current currency

buy_limitnumber

Maximum purchasable amount in the current currency

limit_amountnumber

Maximum amount available for subscription, including the subscription fee

total_amountnumber

Reference maximum purchasing power, including other currencies converted

is_borrowingboolean

Whether the purchasing power includes financing. When false and limit_amount is not greater than 0, you can guide the Client to exchange currency

detailsarray<object>

Cash details by currency

Child attributes
currencystring

Currency, such as USD or HKD

amountnumber

Cash amount in the currency

namestring

Name

Whale Docs