Skip to content
Fund Trading

Get Fund Order Page Information

Call this when the Client opens the buy (subscription) or sell (redemption) page of a fund. It returns all static information the order page needs: fund name and settlement currency, latest NAV, subscription and redemption fees, minimum initial and additional subscription amounts, minimum holding and minimum sell limits, available dividend options, fund documents and agreement text, and, for selling, the held units, frozen units, and in-transit sell orders. For a buy, call Get Fund Purchasing Power with currency. For a sell, the sellable units are holding.holding_units minus holding.freeze_units, truncated to unit_decimal_places decimal places.

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

GEThttps://api.lbkrs.com/v1/ut/order/info

Parameters

counter_idstringqueryRequired

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 order page information” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
codestring

Fund display code

fund_namestring

Fund name

currencystring

Fund settlement currency. Subscriptions are paid in this currency

bid_pricestring

Latest fund NAV

dealing_datestring

Dealing date

purchase_amountstring

Minimum initial subscription amount

additional_purchase_amountstring

Minimum additional subscription amount when the Client already holds the fund

purchase_ratestring

Subscription fee rate as a decimal, such as 0.015 for 1.5%

redemption_ratestring

Redemption fee rate as a decimal

bill_purchase_ratestring

Adjusted subscription fee rate

bill_redemption_ratestring

Adjusted redemption fee rate

bill_purchase_gst_ratestring

GST (goods and services tax) rate on subscriptions

bill_redemption_gst_ratestring

GST rate on redemptions

dividendarray<object>

Available dividend options. value is 2 (reinvest) or 4 (cash), passed as dividend_option on submission

Child attributes
textstring

Display text

valuestring

Machine value to send back on submission

min_hold_sharestring

Minimum holding units. Remaining units after a sell must not fall below this value

min_hold_cashstring

Minimum holding amount

min_sell_sharestring

Minimum units per sell order

min_sell_amountstring

Minimum amount per sell order

unit_decimal_placesinteger

Number of decimal places for units. -1 means using the decimal places of the held units

holdingobject

Current holding

Child attributes
holding_unitsnumber

Held units

freeze_unitsnumber

Frozen units (reserved by in-transit sell orders)

amountnumber

Holding amount

transit_amountstring

In-transit sell amount

available_amountstring

Amount actually available to sell

transit_order_cntinteger

Number of in-transit sell orders

transit_order_idinteger

In-transit order ID. Meaningful only when transit_order_cnt is 1; otherwise 0

trade_detailsarray<object>

Whether each account channel supports buying and selling the fund

Child attributes
account_channelstring

Account channel

support_buyboolean

Whether buying is supported

support_sellboolean

Whether selling is supported

buy_statementstring

Agreement text the Client must accept when buying

sell_statementstring

Agreement text the Client must accept when selling

risk_disclosure_tipstring

Risk disclosure notice shown in the agreement area

pdfsarray<object>

Fund documents

Child attributes
announcement_typeinteger

Document type:

  • 1 - Announcement
  • 2 - Prospectus
  • 3 - Fund factsheet
  • 4 - Product key facts statement
  • 5 - Other
Values
1
2
3
4
5
namestring

Document name

linkstring

Document (PDF) URL

Whale Docs