Input - Cancel Order
Cancel a working order by the Venue Order ID and/or Customer Order ID.
Fields
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | header | |||||
2 | → applicationName | Application Name | String | REQUIRED | Identifies the application generating the message. | |
3 | → applicationVendor | Application Vendor | String | REQUIRED | Identifies the vendor of the application generating the message. | |
4 | → applicationVersion | Application Version | String | REQUIRED | Identifies the version of the application generating the message. | |
5 | → messageType | Message Type | MessageType |
| REQUIRED | |
6 | → requestId | Request ID | String | REQUIRED | A unique identifier for the request provided by the client for correlation. | |
7 | → sentTime | Sent Time | DateTime | REQUIRED | Timestamp of the message leaving the producing application. | |
8 | payload | |||||
9 | → customerOrderId | Customer Order ID | String |
| REQUIRED | |
10 | → entities | |||||
11 | → → customerAccountId | Customer Account ID | String |
| REQUIRED | |
12 | → → customerOriginType | Customer Origin Type | OriginType |
| REQUIRED | |
13 | → → customerType | Customer Type | CustomerType |
| REQUIRED | |
14 | → → executingFirmId | Executing Firm ID | String |
| REQUIRED | |
15 | → → operatorId | Operator ID | String |
| REQUIRED | |
16 | → → senderCountry | Sender Country | String |
| REQUIRED | |
17 | → → senderState | Sender State | String |
| OPTIONAL | |
18 | → instrument | |||||
19 | → → glbxSecurityId | Globex Security ID | Integer | REQUIRED | ||
20 | → manualInd | Manual Indicator | YesNoIndicator |
| REQUIRED | Indicates whether the order was generated by automated trading logic. |
21 | → sideInd | Side Indicator | MarketSideIndicator |
| REQUIRED | |
22 | → venueOrderId | Venue Order ID | String | OPTIONAL |
Output - Cancel Order Response - Success
Fields
Ref | Field | Name | Data Type | Values | Usage | Description | ||
---|---|---|---|---|---|---|---|---|
1 | header | |||||||
2 | → messageType | Message Type | messageType |
| ALWAYS | |||
3 | → possibleRetransInd | Possible Retransmission Indicator | yesNoIndicator |
| OPTIONAL | |||
4 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |||
5 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. | |||
6 | → sequenceNbr | Sequence Number | string | ALWAYS | ||||
7 | payload | |||||||
8 | → action | Action | orderAction |
| ALWAYS | |||
9 | → cancelReason | Cancel Reason | orderCancelReason |
| OPTIONAL | |||
10 | → cumulativeQtyInt | Cumulative Quantity Integer | int32 | ALWAYS | ||||
11 | → customerOrderId | Customer Order ID | string | ALWAYS | ||||
12 | → displayQtyInt | Display Quantity Integer | int32 | OPTIONAL | ||||
13 | → durationType | Duration Type | orderDurationType |
| ALWAYS | |||
14 | → entities | |||||||
15 | → → customerAccountId | Customer Account ID | string | ALWAYS | ||||
16 | → → customerOriginType | Customer Origin Type | originType |
| ALWAYS | |||
17 | → → customerType | Customer Type | customerType |
| ALWAYS | |||
18 | → → executingFirmId | Executing Firm ID | string | ALWAYS | ||||
19 | → → senderCountry | Sender Country | string | ALWAYS | ||||
20 | → → senderState | Sender State | string | OPTIONAL | ||||
21 | → expirationDt | Expiration Date | date | CONDITIONAL | Criteria
| |||
22 | → instrument | |||||||
23 | → → glbxSecurityId | Globex Security ID | int32 | ALWAYS | ||||
24 | → manualInd | Manual Indicator | yesNoIndicator |
| ALWAYS | Indicates whether the order was generated by automated trading logic. | ||
25 | → minimumQtyInt | Minimum Quantity Integer | int32 | OPTIONAL | ||||
26 | → price | Price | price | CONDITIONAL | Criteria
| |||
27 | → qtyInt | Quantity Integer | int32 | ALWAYS | ||||
28 | → sideInd | Side Indicator | marketSideIndicator |
| ALWAYS | |||
29 | → status | Status | orderStatus |
| ALWAYS | |||
30 | → stopPrice | Stop Price | price | CONDITIONAL | Criteria
| |||
31 | → transactionTime | Transaction Time | dateTime | ALWAYS | ||||
32 | → type | Type | orderType |
| ALWAYS | |||
33 | → venueExecutionId | Venue Execution ID | string | ALWAYS | ||||
34 | → venueOrderId | Venue Order ID | string | ALWAYS |
Output - Cancel Order Response - Error
Fields
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string | ALWAYS | ||
3 | → message | Message | string | ALWAYS | ||
4 | → referenceField | Reference Field | string | OPTIONAL | ||
5 | header | |||||
6 | → messageType | Message Type | messageType |
| ALWAYS | |
7 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
8 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. | |
9 | → sequenceNbr | Sequence Number | string | ALWAYS | ||
10 | payload | |||||
11 | → customerOrderId | Customer Order ID | string | ALWAYS | ||
12 | → transactionTime | Transaction Time | dateTime | OPTIONAL | ||
13 | → venueOrderId | Venue Order ID | string | OPTIONAL |