Trade model: MMSettlement

This page describes the FX Integration API’s MMSettlement 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 MMSettlement 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
SettlementAction
Action
string
Withdraw or deposit for Call Deposit.
TradeID
string
The unique id identifying the trade.
SettlementInstructions
SettlementLeg Un
Un_PaySettlementId
The Id corresponding to the payee's settlement details.
Un_PaySettlementRemarks
The remarks corresponding to the payee's settlement details.
Un_PaySettlementInstructionType
The type of settlement instruction on the pay side.
Un_ReceiveSettlementId
The Id corresponding to the recipient's settlement details.
Un_ReceiveSettlementRemarks
The remarks corresponding to the recipient's settlement details.
Un_ReceiveSettlementInstructionType
The type of settlement instruction on the receive side.
Un_ReceiveSettlementType
The type of settlement attached to a trade. Supported types are [PRINCIPAL, INTEREST].
IsInterestSplit
Whether the receive instruction is split into separate principal and interest instructions
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