Trade model: OrderCancel

This page describes the FX Integration API’s OrderCancel trade model, as defined in the file config/OrdersAdapter/Blade/DataSource/etc/trademodels.xml in the FX Integration API Kit.

This documentation is for the FX Integration API 3.53.0.

Trade models are XML-defined state machines used by the Java Trading API, the C Trading API, and Caplin Trader’s Trading API to manage trading workflows. For more information on trade model XML definitions, see the Trade model XML schema reference.

State diagram

The state diagram for the Order Cancellation trade model is shown below. To simplify the diagram, the Timeout and Error states have been omitted.

InitialCancelSentCancelingDoneRejectedPendingCancelCancelAckCancelConfirmCancelRejectCancelPendingLegendTransitions initiated by the client are inyellow.Transitions initiated by the server are inblue.

Messages: client → server

Trade-channel messages sent by StreamLink clients to the FX API DataSource.

For high-level information on message fields, see Message and record fields. For information about fields in specific messages, see the message specifications below.

Cancel
MsgType
String
Example: Cancel
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
OrderID
string
The id of the order.

Messages: server → client

Trade-channel messages sent by the FX API DataSource to StreamLink clients.

For high-level information on message fields, see Message and record fields. For information about fields in specific messages, see the message specifications below.

CancelAck
MsgType
String
Example: CancelAck
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
CancelConfirm
MsgType
String
Example: CancelConfirm
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
CancelReject
MsgType
String
Example: CancelReject
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
CancelPending
MsgType
String
Example: CancelPending
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model