Trade model: Commodities Settlement

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

This documentation is for the FX Integration API 8.2.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 CommoditiesSettlement trade model is shown below. To simplify the diagram, the Rejected and Error states have been omitted.

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

Messages: client → server

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.

Request
CommoditiesSettlementInstructions
Action
Affirm, Confirm, Dispute, Cancel, Replace, AutoConfirm, Unconfirm, Net, ApproveInstructions, RejectInstructions or Release
TradeID
string
Example: 00001561
A unique identifier for this trade
SettlementStatus
string
Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]
MsgType
String
Example: Request
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

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.

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