Create an Individual Order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint when creating an individual investor order for a fund/share class. The request must include a partner-unique referenceId, the investor, account, fund, share class, side, distribution election, tax lot election, and route instruction.
Note that this endpoint is for individual orders. For orders submitted as part of model portfolios, use the /primary/v1/omnibus/model-order endpoint.

Notes:

  • referenceId must be unique across all Orders.
  • externalAccountNumber is resolved at intake to an internal account id.
  • For SELL Orders: the Individual Order will be rejected if it will result in a negative share balance for the associated Investor.
  • For BUY Orders: custodians are responsible for checking to ensure that Investors have sufficient cash to fund their BUY Order.
  • The investor must belong to a Financial Institution that has access to the registered fund.
  • An Omnibus Account must already exist for the fund, share class, and distribution election method, held by the custodian or, in the MMM Securities master omnibus, by MMM Securities.
  • If Order Actions apply, the order is created with status PendingActions and downstream routing to the transfer agent is deferred until the required actions are completed. Use the /primary/v1/omnibus/order-action/order/{orderid} endpoint to fetch all Order Actions, and the /primary/v1/omnibus/order-action/{id}/complete endpoint to complete them.

Body Params

Order submission details. Buy orders use notionalAmount; sell orders use quantity.

Request model for submitting a new Omnibus order.

string
required
length between 1 and 100

Partner-submitted order reference. Must be unique per partner.

uuid
required
length ≥ 1

Monark account identifier. Primary resolves the compatibility investor from this account.

uuid | null

Optional financial advisor associated with the investor's financial institution.

uuid
required
length ≥ 1

Registered fund being traded.

uuid
required
length ≥ 1

Share class being traded. Must belong to the omnibus fund.

string
enum
required

Order side: buy or sell.

Allowed:
double | null

Share quantity. Required for sell orders and omitted for buy orders.

double | null

Dollar notional amount. Required for buy orders and omitted for sell orders.

string | null

Order currency. Only USD is supported for the first version.

string
enum
required

Distribution election used as part of the position identity.

Allowed:
string
enum
required

Tax lot election for sell order handling.

Allowed:
taxLotIds
array of uuids | null

Optional tax lot identifiers to sell first, in priority order. Sell orders only.
Lots must be open and held by the account at submission. Lot targeting is best effort:
if a lot is no longer available at settlement, the remaining quantity follows primary_offering_api_models.Omnibus.CreateOmnibusOrderRequest.TaxLotElection.

taxLotIds
string | null
enum

Requested downstream route for this order. When omitted for backward
compatibility, OMS resolves the order to primary_offering_api_models.Omnibus.Enums.OmnibusRouteInstruction.TransferAgent.
Netting routes are accepted only when the configured order-netting
capability is available for this order.

Allowed:
string | null

Optional client model or rebalance identifier.

string | null
enum

Instructions for the unmatched balance after netting TIF expires. Used only for netting routes. Defaults to TransferAgent, which requires Cutoff NettingTif.

Allowed:
string | null
enum

Netting time in force. Used only for netting routes. Defaults to Cutoff. Other values require UnnettedOrderRoute = Cancel.
EOD: the next netting session only. Cutoff: every session up to the next TA cutoff. EOM/EOQ: every session up to
the last one in the month/quarter of the order's first session. Custom: every session on or before nettingTifDate.
A session that doesn't run (for example its NAV is missing) doesn't extend the order: at its deadline the order goes
to the TA cutoff or is cancelled, as the order asked.

Allowed:
date | null

Custom netting date, used only for Custom TIF: every session on or before this date. When omitted, Custom behaves as Cutoff.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json