Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
hiddenfalse



Style
.wiki-content .columnLayout .cell.aside {width:400px;}



Panel
borderColorlightgray


Page Properties







Panel
borderColorlightgray
titleBGColorwhitesmoke
titleContents
Table of Contents
maxLevel3


Input - Cancel Order


Cancel a working order by the Venue Order ID and/or Customer Order ID.


Fields

RefFieldNameData TypeValuesUsageDescription
1header
2→ applicationNameApplication NameString
REQUIRED

Identifies the application generating the message.

3→ applicationVendorApplication VendorString
REQUIRED

Identifies the vendor of the application generating the message.

4→ applicationVersionApplication VersionString
REQUIRED

Identifies the version of the application generating the message.

5→ messageTypeMessage TypeMessageType
  • ORDCXL ORDCXL (Order Cancel)
REQUIRED
6→ requestIdRequest IDString
REQUIRED

A unique identifier for the request provided by the client for correlation.

7→ sentTimeSent TimeDateTime
REQUIRED

Timestamp of the message leaving the producing application.

8payload
9→ customerOrderIdCustomer Order IDString
  • Length: 1 - 20
REQUIRED
10→ entities
11→ → customerAccountIdCustomer Account IDString
  • Length: 1 - 12
REQUIRED
12→ → customerOriginTypeCustomer Origin TypeOriginType
  • CUSTOMER CUSTOMER (Customer)
  • HOUSE HOUSE (House)
REQUIRED
13→ → customerTypeCustomer TypeCustomerType
  • MEMBER_OWN OWN (Member Own) - Applies to orders entered or trades executed by an individual member for their own account, for an account they controls, or for an account in which they have an ownership or financial interest. However, transactions initiated and executed by a member for the proprietary account of a member firm must be designated as Member Other Member transactions.
  • MEMBER_PROPRIETARY PROPRIETARY (Member Proprietary) - Applies to orders entered or trades executed for the proprietary accounts of a member firm, including Rule 106.H., I., N., R. and S. firms.
  • ON_BEHALF_INDIVIDUAL INDIVIDUAL (On-Behalf Individual) - Applies to orders entered by a member or a nonmember terminal operator for the account of another individual member or an account controlled by such individual member.
  • OTHER OTHER (Other) - Applies to all orders and transactions not included in any of the defined categories. These typically are orders entered by or on behalf of nonmember entities.
REQUIRED
14→ → executingFirmIdExecuting Firm IDString
  • Length: 1 - 10
REQUIRED
15→ → operatorIdOperator IDString
  • Length: 1 - 18
REQUIRED
16→ → senderCountrySender CountryString
  • Length: 1 - 2
REQUIRED
17→ → senderStateSender StateString
  • Length: 2 - 2
OPTIONAL
18→ instrument
19→ → glbxSecurityIdGlobex Security IDInteger
REQUIRED
20→ manualIndManual IndicatorYesNoIndicator
  • NO NO (No) - No
  • YES YES (Yes) - Yes
REQUIRED

Indicates whether the order was generated by automated trading logic.

21→ sideIndSide IndicatorMarketSideIndicator
  • BUY BUY (Buy) - Identifies a buy side order
  • CROSS CROSS (Cross)
  • SELL SELL (Sell) - Identifies a sell side order
REQUIRED
22→ venueOrderIdVenue Order IDString
OPTIONAL

Output - Cancel Order Response - Success

Fields

RefFieldNameData TypeValuesUsageDescription
1header
2→ messageTypeMessage TypemessageType
  • ORDSTS ORDSTS (Order Status)
ALWAYS
3→ possibleRetransIndPossible Retransmission IndicatoryesNoIndicator
  • NO NO (No) - No
  • YES YES (Yes) - Yes
OPTIONAL
4→ requestIdRequest IDstring
ALWAYS

A unique identifier for the request provided by the client for correlation.

5→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

6→ sequenceNbrSequence Numberstring
ALWAYS
7payload
8→ actionActionorderAction
  • CANCEL CANCEL (Cancel)
ALWAYS
9→ cancelReasonCancel ReasonorderCancelReason


Expand
  • AGGRESSIVE_SELF_MATCH MATCH (Aggressive Self-Match)
  • CREDIT_CONTROL CONTROL (Credit Control)
  • DISCONNECT DISCONNECT (Disconnect)
  • EXCHANGE EXCHANGE (Exchange)
  • MINIMUM_QUANTITY QUANTITY (Minimum Quantity)
  • NOT_BEST BEST (Not Best)
  • RESTING_SELF_MATCH MATCH (Resting Self-Match)
  • RISK_MANAGEMENT MANAGEMENT (Risk Management)


OPTIONAL
10→ cumulativeQtyIntCumulative Quantity Integerint32
ALWAYS
11→ customerOrderIdCustomer Order IDstring
ALWAYS
12→ displayQtyIntDisplay Quantity Integerint32
OPTIONAL
13→ durationTypeDuration TypeorderDurationType
  • DAY DAY (Day) - Order expires at the end of the trading day.
  • FILL_AND_KILL KILL (Fill and Kill) - Order is immediately executed against any available quantity and any remaining quantity is eliminated
  • FILL_OR_KILL KILL (Fill or Kill) - Order is filled completely or else eliminated
  • GOOD_TILL_CANCEL CANCEL (Good till Cancel) - Order remains working until cancelled
  • GOOD_TILL_DATE DATE (Good till Date) - Order remains working until the end of the trading session of the local market date specified in the ExpirationDate field.
ALWAYS
14→ entities
15→ → customerAccountIdCustomer Account IDstring
ALWAYS
16→ → customerOriginTypeCustomer Origin TypeoriginType
  • CUSTOMER CUSTOMER (Customer)
  • HOUSE HOUSE (House)
ALWAYS
17→ → customerTypeCustomer TypecustomerType
  • MEMBER_OWN OWN (Member Own) - Applies to orders entered or trades executed by an individual member for their own account, for an account they controls, or for an account in which they have an ownership or financial interest. However, transactions initiated and executed by a member for the proprietary account of a member firm must be designated as Member Other Member transactions.
  • MEMBER_PROPRIETARY PROPRIETARY (Member Proprietary) - Applies to orders entered or trades executed for the proprietary accounts of a member firm, including Rule 106.H., I., N., R. and S. firms.
  • ON_BEHALF_INDIVIDUAL INDIVIDUAL (On-Behalf Individual) - Applies to orders entered by a member or a nonmember terminal operator for the account of another individual member or an account controlled by such individual member.
  • OTHER OTHER (Other) - Applies to all orders and transactions not included in any of the defined categories. These typically are orders entered by or on behalf of nonmember entities.
ALWAYS
18→ → executingFirmIdExecuting Firm IDstring
ALWAYS
19→ → senderCountrySender Countrystring
ALWAYS
20→ → senderStateSender Statestring
OPTIONAL
21→ expirationDtExpiration Datedate
CONDITIONAL
Criteria
  • ALWAYS when payloadwhen payload.type = "GOOD_TILL_DATE"
22→ instrument
23→ → glbxSecurityIdGlobex Security IDint32
ALWAYS
24→ manualIndManual IndicatoryesNoIndicator
  • NO NO (No) - No
  • YES YES (Yes) - Yes
ALWAYS

Indicates whether the order was generated by automated trading logic.

25→ minimumQtyIntMinimum Quantity Integerint32
OPTIONAL
26→ pricePriceprice
CONDITIONAL
Criteria
  • ALWAYS when payloadwhen payload.type IN (LIMIT, STOP_LIMIT)
27→ qtyIntQuantity Integerint32
ALWAYS
28→ sideIndSide IndicatormarketSideIndicator
  • BUY BUY (Buy) - Identifies a buy side order
  • CROSS CROSS (Cross)
  • SELL SELL (Sell) - Identifies a sell side order
ALWAYS
29→ statusStatusorderStatus
  • CANCELED CANCELED (Canceled)
  • UNDEFINED UNDEFINED (Undefined)
ALWAYS
30→ stopPriceStop Priceprice
CONDITIONAL
Criteria
  • ALWAYS when payloadwhen payload.type IN (STOP, STOP_LIMIT)
31→ transactionTimeTransaction TimedateTime
ALWAYS
32→ typeTypeorderType
  • LIMIT LIMIT (Limit) - A Limit order defines the upper price limit at which to buy an instrument and lower price limit at which to sell an instrument. The price limit is defined in the Price field. If the price is not immediately available, the Limit order will rest until filled or cancelled.
  • MARKET MARKET (Market) - A Market order with protection is filled within a pre-defined range of prices referred to as the protected range. For buy orders, protection points are added to the current best offer price to calculate the protection price limit. For sell orders, protection points are subtracted from the current best bid price.
  • MARKET_TO_LIMIT LIMIT (Market to Limit) - A Market-limit order is executed at the best price available in the market. If the market-limit order can only be partially filled, the order becomes a limit order and the remaining quantity remains on the order book at the specified limit price.
  • STOP STOP (Stop) - A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop order goes on the book as a Market order once triggered.
  • STOP_LIMIT LIMIT (Stop Limit) - A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop-Limit order goes on the book as a Limit order once triggered.
ALWAYS
33→ venueExecutionIdVenue Execution IDstring
ALWAYS
34→ venueOrderIdVenue Order IDstring
ALWAYS

Output - Cancel Order Response - Error

Fields

RefFieldNameData TypeValuesUsageDescription
1errors[]
2→ codeCodestring
ALWAYS
3→ messageMessagestring
ALWAYS
4→ referenceFieldReference Fieldstring
OPTIONAL
5header
6→ messageTypeMessage TypemessageType
  • ORDCXLRJ ORDCXLRJ (Order Cancel Reject)
ALWAYS
7→ requestIdRequest IDstring
ALWAYS

A unique identifier for the request provided by the client for correlation.

8→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

9→ sequenceNbrSequence Numberstring
ALWAYS
10payload
11→ customerOrderIdCustomer Order IDstring
ALWAYS
12→ transactionTimeTransaction TimedateTime
OPTIONAL
13→ venueOrderIdVenue Order IDstring
OPTIONAL