Skip to content
Fund Orders

Get Fund Order Details

Returns the complete information of one fund order, its progress stages (stages), and key fields (keywords) for the order details page. Call it again after submitting or canceling an order to refresh the state. When order.withdrawable is true, you can show the cancel option. stages and keywords are localized and can be rendered in order as is.

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

GEThttps://api.lbkrs.com/ut/order/detail

Parameters

idstringqueryRequired

Fund order ID

account_channelstringquery

Account channel. Use the account_channel of the current account

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 details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
orderobject

Fund order

Child attributes
idinteger

Fund order ID. Pass it as ut_id when canceling

counter_idstring

Fund ID (counter_id)

fund_namestring

Fund name

actionstring

Trade direction:

  • BUY - Buy (subscription)
  • SELL - Sell (redemption)
  • SWITCH - Switch
Values
BUY
SELL
SWITCH
currencystring

Currency, such as USD or HKD

amountstring

Order amount: the total amount paid for a buy, or the estimated amount for the units of a sell

unitsstring

Order units

net_worthstring

Executed net asset value (NAV)

sales_chargestring

Sales charge rate

dividend_optionstring

Dividend option:

  • 2 - Reinvest dividends
  • 4 - Cash dividends
fund_sourcestring

Funding source. 2 means cash

account_channelstring

Account channel of the ordering account

statusinteger

Order status code:

  • 0 - Submitted
  • 2, 4, 6 - Confirmed
  • 8 - Canceled
  • 9 - Rejected

Prefer state_desc for display.

statestring

Order state:

  • Init - Initial
  • Cutoff - Past the cutoff time
  • Submitted - Submitted
  • FundsSettled - Redemption proceeds settled
  • Done - Completed
  • Canceled - Canceled
  • Rejected - Rejected
state_descstring

Localized display text of the order state

withdrawableboolean

Whether the order can be canceled. When true, you can call Cancel Fund Order

is_autoboolean

Whether the order was generated automatically, such as a cash management auto-subscription or a recurring investment debit

created_atinteger

Order creation time, as a Unix timestamp in seconds

processed_atinteger

Unit confirmation (execution) time, as a Unix timestamp in seconds

price_atinteger

NAV confirmation time, as a Unix timestamp in seconds

withdraw_atinteger

Cancellation time, as a Unix timestamp in seconds

transaction_atinteger

Settlement time (when returns become visible for a buy, or when cash arrives for a sell), as a Unix timestamp in seconds

sales_pricestring

Confirmed NAV

sales_unitstring

Confirmed units

sale_proceedsstring

Sell proceeds pending credit

feestring

Order fee

total_amountstring

Total order amount including fees

product_typestring

Product type:

  • UT - Public fund
  • PE - Private fund
  • MMF - Cash management (money market fund)
stagesarray<object>

Order progress stages in chronological order

Child attributes
keystring

Stage identifier

stagestring

Localized stage name, such as “Submitted” or “Units confirmed”

descstring

Localized time description of the stage

progressstring

Stage status:

  • done - Completed
  • current - In progress
  • pending - Pending
Values
done
current
pending
link_textstring

Localized text of the link attached to the stage

linkstring

Link attached to the stage

keywordsarray<object>

Order key fields in display order

Child attributes
keystring

Field identifier

titlestring

Localized field title

contentstring

Field content that you can show as is

groupstring

Group the field belongs to. Show fields of the same group together

line_strategystring

How to handle content longer than one line:

  • Intercept - Truncate with an ellipsis
  • Wrap - Wrap to the next line

If empty, use the default style.

Whale Docs