Create Order

post

https://bo-api.drivewealth.io/back-office/orders

Create an Order.

Body Params

accountNo

string

required

The user's assiocated account number.

orderType

string

enum

required

The type of the Order.

Allowed:

limitType

string

enum

Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments.

Allowed:

symbol

string | null

The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their instrumentID or ISIN.

side

string

enum

required

Whether an order is to purchase or sell. Generally, the value should be set to BUY or SELL. For Options orders, BUY_OPEN, BUY_CLOSE, SELL_OPEN, SELL_CLOSE should be used.

Allowed:

instrumentID

uuid

A unique ID created by DriveWealth to identify a specific instrument.

ISIN

string

length between 12 and 14

An International Securities Identification Number (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a symbol, such as Debt Instruments and Global Mutual Funds.

quantity

double

The unit quantity to purchase or sell. Required if amountCash is null.

amountCash

double

The USD-denominated amount to purchase or sell.

price

double

The price for non-MARKET Order types. This would be required if placing a LIMIT, STOP, or MARKET_IF_TOUCHED order.

currency

string

enum

The name of the currency in abbreviation form.

Allowed:

commission

double

A USD amount to charge as commission for an Order. This defaults to using an Account's assigned Commission Schedule if unset. For example, 4 will result in a $4.00 commission charge, regardless of the assigned Commission Schedule.

commissionRate

number

0.0001 to 1

The commission rate is a percentage charge to the total amount of the order.

clientNotes

string

Client facing notes that can be added to a request.

preventQueuing

boolean

enum

If set to true, Orders received when the market is closed will not be queued for the next market open, and will be rejected. Please pay attention to the spelling of queuing as there are two valid spellings of this word.

Allowed:

extendedHours

boolean

enum

Whether the order is eligible for Extended Hours Trading. The timeInForce must be set to GTX when this field is true. Only applicable to Equity Orders.

Allowed:

metadata

object

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

timeInForce

string

enum

Set to "GTC" for a good-til-canceled order. Set to "GTX" for extended hours orders. When this property is not set, market and limit orders will be good-for-day by default, while stops and market-if-touched orders will be assumed good-til-canceled.

Allowed:

executionInstructions

array of strings

A list of execution instructions for an order. Currently only supported for Fixed Income orders.

executionInstructions

Allowed:

expiration

date

The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day.

salesCredit

object

If set, the unit price will be marked up or marked down based on the prescribed amount. Only applicable to Orders for Debt Instruments.

dccs

boolean

True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order.

taxLotDisposition

array of objects

taxLotDisposition

travelRuleBankAccountID

string

The travel rule bank account ID. Supported By MARKET, LIMIT, STOP, MARKET_IF_TOUCHED orders. Only if partner enabled to send travel rule.

traderID

string

The trader ID of the individual creating the order.

clientOrderTransactionTime

string

The date with a valid timestamp of when a partner received the order from the customer.

clientOrderRouteTime

string

The date with a valid timestamp of when DW received the order from the partner.

clientOrderID

string

A unique identifier that represents the order, as defined by the partner. This detail will be reported to the CAT system for US brokers to more easily reconcile reported information.

deptType

string

enum

The name of the department in abbreviation form.

Allowed:

clientID

string

A unique identifier from the partner's platform that represents the customer who placed this order. This detail should be supplied for orders in an omnibus account.

Responses

200Creating an Order was Successful.

400Bad Request

403Account restricted to make day trades