Trade model: PostTradeAllocation

This page describes the FX Integration API’s PostTradeAllocation 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 8.15.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.

Contents:

State diagram
Messages: client → server
Messages: server → client

State diagram

The state diagram for the PostTradeAllocation trade model is shown below. To simplify the diagram, the Error state has been omitted.

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.

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

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

TradeID

string

Example: 00001561

A unique identifier for this trade

AppID

A unique identifier for the client application

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.

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

AllocationConfirmation