Skip to content
Fund Trading

Submit Fund Order

Submits a fund buy (subscription) or sell (redemption) order. On success, the order is created and the Client's available cash (buy) or sellable units (sell) change accordingly, so refresh the asset and holdings display. The order is then confirmed with NAV and units according to the fund dealing date, and you can track it with Get Fund Order Details. When the order withdrawable is true, it can be canceled.

Prerequisites: the trade token is valid; for a buy, Validate Fund Order Risk (user_pi is 2) and Get Fund Order Certification Checks (no is_force item) have been completed in order; and the Client has accepted the fund documents and agreement. For a buy, pass amount and dividend_option. For a sell, pass units, and set is_sell_all to true to sell the entire holding.

On failure, no order is created. Handle compliance business codes as described and show message to the Client for other errors. Whether the service deduplicates repeated submissions is not confirmed. If the request times out, check Get Fund Order List for a new order before deciding whether to submit again.

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

POSThttps://api.lbkrs.com/v2/ut/order/submit

Parameters

x-target-aaidstringheader

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

Request body application/json

counter_idstringrequired

Fund ID (counter_id)

actionstringrequired

Trade direction:

  • BUY - Buy (subscription)
  • SELL - Sell (redemption)
Values
BUY
SELL
currencystringrequired

Payment or settlement currency, from currency in the order page information

amountstringrequired

Buy amount. Pass an empty string for a sell unless selling by amount

unitsstringrequired

Sell units. Pass an empty string for a buy. Decimal places must not exceed unit_decimal_places in the order page information

dividend_optionstring

Dividend option for a buy: 2 reinvest or 4 cash, from dividend[].value in the order page information

is_sell_allboolean

Whether to sell all sellable units. Used for a sell only

fund_sourcestring

Funding source. Pass 2 (cash)

auth_tokenstring

auth_token returned by Validate Fund Order Risk

declarationstring

The Client has confirmed the declaration. Pass 1

term_conditionstring

The Client has accepted the terms and conditions. Pass 1

account_channelstring

Account channel. Use the account_channel of the current account

Responses

HTTP 200The request succeeded. The response body contains the result of the “Submit fund order” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Fund order submission result

idstring

ID of the new fund order. Use it with Get Fund Order Details and Cancel Fund Order

counter_idstring

Fund ID (counter_id)

fund_namestring

Fund name

actionstring

Trade direction, BUY or SELL

amountstring

Order amount

unitsstring

Order units

statusinteger

Order status code:

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

Prefer state_desc for display.

created_atinteger

Order creation time, as a Unix timestamp in seconds

msgstring

Additional prompt text

HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs