Trade model: Post-Trade Allocation

This page describes the FX Integration API’s Post-Trade Allocation 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.40.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 Post-Trade Allocation trade model is shown below. To simplify the diagram, the Error state has been omitted.

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

For the sake of clarity, the states Rejected and Error have been omitted from the state diagram.

Messages: client → server

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

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

Messages: server → client

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

AllocationConfirmation
MsgType
String
Example: AllocationConfirmation
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
ClientCloseAck
MsgType
String
Example: ClientCloseAck
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
Hold
MsgType
String
Example: Hold
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
PickUp
MsgType
String
Example: PickUp
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
SubmitAck
MsgType
String
Example: SubmitAck
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model