Skip to content
Fund Orders

Get Fund Order List

Returns the Client's fund orders page by page, filtered by direction, status, month, or time range, for the fund transaction records page. Paginate with page and size; fewer records than size means there are no more. Use action / status for single-select filters (-1 means all) and comma-separated actions / states for multi-select filters. When the Client selects an order, call Get Fund Order Details with its id.

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

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

Parameters

pageintegerquery

Page number, starting from 1

sizeintegerquery

Number of records per page. Broker App passes 20

actionintegerquery

Trade direction (single select):

  • -1 - All
  • 0 - Buy
  • 1 - Sell

-101

statusintegerquery

Order status (single select):

  • -1 - All
  • 0 - In progress
  • 1 - Canceled
  • 2 - Completed
  • 3 - Failed

-10123

actionsstringquery

Trade directions (multi-select), comma-separated, using action values except -1, such as 0,1

statesstringquery

Order statuses (multi-select), comma-separated, using status values except -1, such as 0,2

year_monthstringquery

Filter by month in YYYYMM format. Pass an empty string for all months

startintegerquery

Start time as a Unix timestamp in seconds. Use it with end

endintegerquery

End time as a Unix timestamp in seconds, exclusive

counter_idarrayquery

Return orders of the specified funds only. You can pass multiple fund IDs; omit it to return all funds

currencystringquery

Filter by currency. Omit it for all currencies

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 list” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
ordersarray<object>

Orders on the current page, newest first

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

Whale Docs