Trade model: MM Capital Increase

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

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

InitialDetailsRequestedDetailsProvidedClientCloseSentSubmittedIncreasedClientClosedDetailsRequestDetailsUpdateClientCloseSubmitClientCloseIncreasedAckClientCloseAckLegendTransitions 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.

DetailsRequest
MsgType
String
Example: DetailsRequest
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
TradeID
string
The unique id identifying the 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
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
IncreasedAmount
decimal
The increased principal amount for the trade in capital increase.
AppID
A unique identifier for the client application

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.

DetailsUpdate Post Trade
Example
API
PostTradeFields
API
TradeID
string
The unique id identifying the trade.
OriginalAmount
decimal
The original principal amount for the trade in capital increase.
PrincipalAmount
decimal
Principal amount for the trade specified in the provided Currency.
StartDate
date
The start date of the trade.
MaturityDate
date
The maturity date of the trade.
NumberOfDays
string
The number of days between the start and maturity dates.
InterestRate
decimal
Interest rate on the given PrincipalAmount.
InterestRateDPS
decimal
The precision for a specified InterestRate.
Currency
string
The currency in which the trade is made.
TradingType
string
The type of the trade. Supported types are [LOAN, DEPOSIT, CALL-DEPOSIT, TERM-DEPOSIT, FLEXI-NOTICE-DEPOSIT, TREASURY-BILL or GOVERNMENT-BOND].
IncreasedAmount
decimal
The increased principal amount for the trade in capital increase.
RolledAmount
decimal
The rolled principal amount for the trade in roll over.
NoticePeriodDescription
string
Example: 32 Days
The notice period description for the trade, sent as the raw display value or a translation token.
TOBOUser
string
The client who the trade is for.
Account
string
The used account for the trade.
IsShariaTrade
boolean
Example: true
Indicates whether the trade is a Sharia trade
This message has no fields that you can set.
IncreasedAck Post Trade
Example
API
PostTradeFields
API
TradeID
string
The unique id identifying the trade.
OriginalAmount
decimal
The original principal amount for the trade in capital increase.
PrincipalAmount
decimal
Principal amount for the trade specified in the provided Currency.
StartDate
date
The start date of the trade.
MaturityDate
date
The maturity date of the trade.
NumberOfDays
string
The number of days between the start and maturity dates.
InterestRate
decimal
Interest rate on the given PrincipalAmount.
InterestRateDPS
decimal
The precision for a specified InterestRate.
Currency
string
The currency in which the trade is made.
TradingType
string
The type of the trade. Supported types are [LOAN, DEPOSIT, CALL-DEPOSIT, TERM-DEPOSIT, FLEXI-NOTICE-DEPOSIT, TREASURY-BILL or GOVERNMENT-BOND].
IncreasedAmount
decimal
The increased principal amount for the trade in capital increase.
RolledAmount
decimal
The rolled principal amount for the trade in roll over.
NoticePeriodDescription
string
Example: 32 Days
The notice period description for the trade, sent as the raw display value or a translation token.
TOBOUser
string
The client who the trade is for.
Account
string
The used account for the trade.
IsShariaTrade
boolean
Example: true
Indicates whether the trade is a Sharia trade
This message has no fields that you can set.
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