v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Orders

Update Order

Updates an Order by orderID.

patch/orders/{orderID}

Path parameters

orderIDstring required

A unique DriveWealth order identifier created when an order is placed.

Example:IC.0e352bb7-9869-4233-9861-9673544efedd

Request body

method'CANCEL' required

The method in which is requested.

traderIDstring

The trader ID of the individual.

clientOrderTransactionTimestring

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

clientOrderIDstring

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.

Example request

{
  "method": "CANCEL",
  "traderID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "clientOrderTransactionTime": "2024-07-30T22:13:18.000Z",
  "clientOrderID": "5a1762d5-4562",
  "cancelDetails": {
    "initiator": "C",
    "requestedTimestamp": "2023-07-30T22:13:18.000Z",
    "manualCancel": true,
    "comment": "This order has been cancelled"
  }
}

Response

The Order was Successfully Updated.

orderIdstring

A unique identifier for the order.

orderNostring

A human readable order identifier.

Example response

{
  "orderId": "EF.418a5506-256c-4c3c-9d4d-f491522cf7f2",
  "orderNo": "EFXM000103"
}