Skip to main content
POST

Authorizations

Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

x-user-id
string
required

User identifier for the M2M client to specify which user's data to access.

Pattern: ^[a-f0-9]{24}$

Body

application/json

Asset order request. Exactly one branch applies:

  • Market buyside: buy, amount required; orderType omitted or Market; optional executeEtfOrdersInRealtime. limitPrice and timeInForce are not allowed.
  • Market sellside: sell, quantity required; same market rules as buy.
  • Limit buyside: buy, orderType: Limit, amount, limitPrice, and timeInForce required. executeEtfOrdersInRealtime is not allowed.
  • Limit sellside: sell, orderType: Limit, quantity, limitPrice, and timeInForce required. executeEtfOrdersInRealtime is not allowed.
side
enum<string>
required
Available options:
buy
isin
string
required

ISIN of the asset to trade.

Pattern: ^[A-Z]{2}[A-Z0-9]{9}[0-9]$
amount
number<double>
required

Whole-currency amount to invest.

Required range: x >= 0.01
orderType
enum<string>
default:Market

Order type. Omit to default to market.

Available options:
Market
quantity
number<double>

Optional. Ignored for buy orders; included for backward compatibility.

Required range: x >= 0.0001
executeEtfOrdersInRealtime
boolean

Optional override for ETF instruments. Only users flagged for real-time execution can set this to true.

Response

Order created successfully.

Asset transaction enriched with display-ready fields.

id
string
required
category
enum<string>
required
Available options:
AssetTransaction
status
string
required

Current transaction status (Pending, PendingGift, Settled, etc.).

orders
object[]
required
portfolioTransactionCategory
enum<string>
Available options:
update,
buy,
sell
owner
string

User identifier owning the transaction.

portfolio
string

Portfolio identifier associated with the transaction.

consideration
object
executionWindow
object | null

Execution windows separated by asset category (matches domain ExecutionWindowsType)

fees
object | null

Wealthyhood fees on orders and settled transactions (commission, FX, and real-time execution when applicable).

partnerFees
object | null

Present for partner users when countervalue fees apply.