TradeSettle

Section: Transactions
Related Message: TradeSettleReply

Metadata

Message Type: TransactionMessage
Message Number: 1060

Inherited fields

Name	Type	Size (bytes)	Description
MessageType	Integer (unsigned)	2	The unique identifier of this message.
ClientId	Integer (unsigned)	4	The unique identifier of a session with the server, returned in a successful LoginReply message.
RequestId	Integer (unsigned)	4	Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session.

Fields

Name	Type	Size (bytes)	Description
Id	Foreign key to Trade	8	The Id of the Trade that is being confirmed or partially confirmed. Required
Cancel	Integer (unsigned)	1	Set to True if this is a cancel (rather than confirm) action.
Value	Integer (signed)	8	The cash value being confirmed. This amount will move from Unsettled to Actual for a confirm or will be deducted from Unsettled for a cancel. Required Decimals: null
Quantity	Integer (signed)	8	The securities quantity being confirmed. This amount will move from Unsettled to Actual for a confirm or will be deducted from Unsettled for a cancel. Required Decimals: null
TradeCosts	Integer (signed)	8	The internal trade costs amount being confirmed. This amount will move from Unsettled to PendingWithdrawal and a HoldingTransaction will be generated, unless the TradeCostsVerified field below is True, in which case the amount will move to Actual. Decimals: null
ExternalTaxCosts	Integer (signed)	8	The external tax costs amount being confirmed. This amount will be added to PendingWithdrawal and a HoldingTransaction will be generated, unless the TradeCostsVerified field below is True, in which case the amount will move to Actual. Decimals: null
ExternalExerciseCosts	Integer (signed)	8	The external exercise costs amount being confirmed. This amount will be added to PendingWithdrawal and a HoldingTransaction will be generated, unless the TradeCostsVerified field below is True, in which case the amount will move to Actual. Decimals: null
ExternalTradeCostsAction	One of TradeCostsAction	1	Unsettled, Pending or Verified.
ExternalTransactionId	String	20	This is the identifier of this transaction in the external system that initiated it.
TradeSettlementType	One of TradeSettlementType	1	Optional field that provides additional information about the reason for the trade settlement message.