EMAPI Messages/ConstantGroups Revision History 1.7.0 => 1.8.0

Messages

1 General Messages

TaxSnapshotSubscribeReq
TaxStartSnapshot
ChangePasswordReq
TaxReplayStartEvent

1.1 General Messages (Internal)

FlowReverseInfo

2 Subscription

2.1 Establishment

2.2 Surveillance Messages

SystemStatusEvent
SubscriptionTerminationEvent
2.2.1 Surveillance Messages (Internal)
FlowStatus

2.3 Termination Messages

3 Reference Data Messages

TradableInstrument
CdAddCashAccountReq
CdUpdateCashAccountReq

3.1 External Members

CdEnableDisableRtcMemberClientReq
CdAddRtcMemberClientReq
CdUpdateRtcMemberClientReq
CdAddRtcMemberClientClearingLinkReq
CdAddRtcPositionAccountReq
CdEnableDisableRtcPositionAccountReq
CdSetMinimumZARLimitReq
CdSetTradingMemberRiskLimitReq
CdSetClientRiskLimitReq
CdSetTradingMemberAMPercentageReq
CdSetClientAMPercentageReq

3.2 Clearing House

4 Event Messages

DailyAccountSummaryDetailsEvent
WithdrawalNotificationEvent

4.1 Event Messages (Internal)

Trade
RtcTradeExternalData
FxDailyAccountSummaryDetails

4.2 External Members

CmBalancing1Event
CmBalancing2Event

4.3 Clearing House

5 Trade Management Messages

QueryTradesReq
AllocateTradeReq
AggregateTradesReq
AllocateTradeWithTurnReq
CorrectAllocationErrorReq
CorrectPrincipalReq
ModifyPositionSubAccountReq
ExerciseOptionPositionReq
AbandonOptionPositionReq
AssignTradeReq
CancelGiveUpReq
ApproveGiveUpReq
RejectGiveUpReq
AssignTradeWithTurnReq
TripartiteAllocationReq
TripartiteAllocationWithTurnReq
ModifyTradeSubAccountReq
AddCommissionReq
CancelCommissionReq
RejectCommissionReq

5.1 Trade Management Messages (Internal)

TradeRes
Commission

6 Pricing Messages

7 Risk Messages

7.1 External Members

7.2 Clearing House

8 Settlement Messages

GetSettlementInstructionsReq
ConfirmWithdrawalsReq
PaymentAdvice
GetPaymentAdvicesReq

8.1 Settlement Messages (Internal)

SettlementInstruction

8.2 External Members

GetRequestsForFXCollateralReq
RegisterFXCollateralReq
SetCmBalancingStatusReq
SetWithdrawalConfirmStateForAllReq
SetWithdrawalConfirmStateForAllRsp
8.2.1 External Members (Internal)
FXCollateral
FXCollateralStatus
FxInterestRate

8.3 Clearing House

9 Position Messages

9.1 External Members

9.2 Clearing House

10 Reference Data

10.1 General Messages

10.1.1 General Management Messages

Constant Groups

PositionType
PositionReason
FlowStates

Messages

1 General Messages

Message nameField nameAttribute nameChanged fromChanged to
TaxSnapshotSubscribeReqmemberDescriptionOptional attribute defining an alternate member applying the subscription to. Used for 'on behalf of' subscriptions. Note that the user requesting subscription for another member must be authorized to subscribe to another member's information. If this attribute is left empty, the logged-in user's member is used.Not used in this configuration of RTC.
userDescriptionOptional attribute defining an alternate user applying the subsciption to. Used for 'on behalf of' subscriptions. Note that the user requesting subscription for another user must be authorized to subscribe to another user's information If this attribute is left empty, the logged-in user is used.Not used in this configuration of RTC.
TaxStartSnapshotreverseInfoHas been removed.
ChangePasswordReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
TaxReplayStartEventreverseInfoHas been removed.

1.1 General Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
FlowReverseInfoHas been removed.

2 Subscription

2.1 Establishment

2.2 Surveillance Messages

Message nameField nameAttribute nameChanged fromChanged to
SystemStatusEventHas been removed.
SubscriptionTerminationEventHas been removed.
2.2.1 Surveillance Messages (Internal)
Message nameField nameAttribute nameChanged fromChanged to
FlowStatusHas been removed.

2.3 Termination Messages

3 Reference Data Messages

Message nameField nameAttribute nameChanged fromChanged to
TradableInstrumentnegativePriceAllowedHas been added.
CdAddCashAccountReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdUpdateCashAccountReqactingUserHas been removed.
userHas been removed.
memberHas been removed.

3.1 External Members

Message nameField nameAttribute nameChanged fromChanged to
CdEnableDisableRtcMemberClientReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdAddRtcMemberClientReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdUpdateRtcMemberClientReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdAddRtcMemberClientClearingLinkReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdAddRtcPositionAccountReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdEnableDisableRtcPositionAccountReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdSetMinimumZARLimitReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdSetTradingMemberRiskLimitReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdSetClientRiskLimitReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdSetTradingMemberAMPercentageReqactingUserHas been removed.
userHas been removed.
memberHas been removed.
CdSetClientAMPercentageReqactingUserHas been removed.
userHas been removed.
memberHas been removed.

3.2 Clearing House

4 Event Messages

Message nameField nameAttribute nameChanged fromChanged to
DailyAccountSummaryDetailsEventbusinessDateDescriptionBusiness Date.Business Date. The format is yyyy-MM-dd.
timestampDescriptionThe time of the event.The time of the event. The format is yyyy-MM-ddTHH:mm:ss.SSS.
registeredSecuritiesAmountDescriptionregisteredSecuritiesAmount.Registered Securities Amount.
registeredCashAmountDescriptionregisteredCashAmount.Registered Cash Amount.
stateDescriptionState.State. Valid values are: REGISTERED, COLLATERAL_CALCULATED, COLLATERAL_SEC_REGISTERED, COLLATERAL_SEC_STEPOVER, COLLATERAL_FX_REGISTERED, COLLATERAL_FX_STEPOVER, COLLATERAL_CASH_SETTLED, CLIENT_PAYMENTS.
statusDescriptionStatus.Status of execution. Valid values are: SUCCESS, ERROR, OVERRIDE, VALIDATION_FAILED, VALIDATION_WARNING,
statusTextDescriptionStatus Text.Status Text. Description of validation errors.
settlementDateDescriptionSettlement Date.Settlement Date. The format is yyyy-MM-dd.
WithdrawalNotificationEventDescriptionA number of payment advices for that the CM must confirm.A notification event sent to the Clearing Member that there is a number of payment advices that the CM must confirm.
clearingMemberDescriptionID of the CM.Clearing Member ID.

4.1 Event Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
TradetradeTimestampDescriptionThe time the trade occurred.The time the trade occurred. The format is yyyy-MM-ddTHH:mm:ss.SSS.
tradeBusinessDateDescriptionThe business date the trade occurred.The business date the trade occurred. The format is yyyy-MM-dd.
RtcTradeExternalDatatradingSystemMatchIdDescriptionAn system set identifier of the trade report that was used to enter this trade into the system.A system set identifier of the matched trade that was used to enter this trade into the system.
tradingSystemLinkIdDescriptionAn system set identifier of the trade report that was used to enter this trade into the system.A system set identifier of the matched trade that was used to enter this trade into the system.
tradingSystemTradeHalfIdDescriptionAn system set identifier of the trade half from the external trading system.A system set identifier of the trade half from the external trading system.
onBookQuantityDescriptionQuantity from trading system for on-book trades. 0 if trade is Off-book. Kept on each side and not changed after trade management unless for at accumulations. When an accumulated trade is partly allocated, on-book and off-book quantities are no longer maintained.Quantity from trading system for on-book trades. 0 if trade is Off-book. Kept on each side and not changed after trade management unless for accumulations. When an accumulated trade is partly allocated, on-book and off-book quantities are no longer maintained.
offBookQuantityDescriptionQuantity from trading system for reported trades. 0 if trade is On-book. Kept on each side and not changed after trade management unless for at accumulations. When an accumulated trade is partly allocated, on-book and off-book quantities are no longer maintained.Quantity from trading system for reported trades. 0 if trade is On-book. Kept on each side and not changed after trade management unless for accumulations. When an accumulated trade is partly allocated, on-book and off-book quantities are no longer maintained.
FxDailyAccountSummaryDetailsDescriptionFx part of the daily account summary.FX part of the daily account summary.
currencyCodeDescriptionThe currencyCode.The Currency Code, ISO 4217 alphabetic Code. Example: USD

4.2 External Members

Message nameField nameAttribute nameChanged fromChanged to
CmBalancing1EventDescriptionAccount balancing 1 message to CM.Account balancing 1 message to the Clearing Member.
clearingMemberDescriptionID of the CM.Clearing Member ID.
businessDateDescriptionBusiness date which have generated the various payments. Note it is not the actual payment date, which happens at the business day after.Business date which have generated the various payments. Note it is not the actual payment date, which happens at the business day after. The format is yyyy-MM-dd.
settlementDateDescriptionDate when the payment is due.Date when the payment is due. The format is yyyy-MM-dd.
CmBalancing2EventclearingMemberDescriptionID of the CM.Clearing Member ID.
businessDateDescriptionBusiness date which have generated the various payments. Note it is not the actual payment date, which happens at the business day after.Business date which have generated the various payments. Note it is not the actual payment date, which happens at the business day after. The format is yyyy-MM-dd.
settlementDateDescriptionDate when the payment is due.Date when the payment is due. The format is yyyy-MM-dd.

4.3 Clearing House

5 Trade Management Messages

Message nameField nameAttribute nameChanged fromChanged to
QueryTradesReqDescriptionQuery trades request.Query trades from previous days. If the flag hasMore is set in the response, there are too many trades matching the search criteria. The client needs to specify narrower criteria and submit the query again.
tradeBusinessDateFromDescriptionQuery trades from date. Can be current or previous business day.Query trades from date. Can be current or previous business day. The format is yyyy-MM-dd.
tradeBusinessDateToDescriptionQuery trades to date.Query trades to date. The format is yyyy-MM-dd.
tradeTimeFromDescriptionQuery trades from time.Query trades from time. The format is yyyy-MM-ddTHH:mm:ss.SSS.
tradeTimeToDescriptionQuery trades to time.Query trades to time. The format is yyyy-MM-ddTHH:mm:ss.SSS.
possDupHas been removed.
AllocateTradeReqDescriptionAllocate trade to another account.The purpose of trade allocation is to allocate or split a trade from one account to an another account. Allocation is performed by making an opposite trade on the original account and an equal trade on the receiving account.
possDupHas been removed.
AggregateTradesReqDescriptionAccumulate several trade.A number of trades can be accumulated into a single trade with a volume weighted average price. The trades need to be on the same account, the same contract and the same side (only buy or only sell) from current day.
possDupHas been removed.
AllocateTradeWithTurnReqpossDupHas been removed.
CorrectAllocationErrorReqDescriptionCorrect allocation error trade request.To correct when a trade has erroneously been allocated to wrong client, i.e. to move the trade from one client to another.
possDupHas been removed.
CorrectPrincipalReqDescriptionCorrect principal on deal trade request.To move a trade from a client account to a member main or sub account.
possDupHas been removed.
ModifyPositionSubAccountReqDescriptionModify sub account.Request to move a position a from member house main account to member sub account or client suspense account.
possDupHas been removed.
ExerciseOptionPositionReqDescriptionExercise an option position.Exercise an option position. For American style options, this is allowed at any time during the contract’s lifetime. For European style options, this can only be done on the expiry day.
possDupHas been removed.
AbandonOptionPositionReqpossDupHas been removed.
AssignTradeReqDescriptionRequest to assign trade to a member.Request to assign trade to another member.
possDupHas been removed.
CancelGiveUpReqDescriptionRequest to cancel giveup request.Request to cancel giveup request by the initator. The recipient of the GiveUpEvent will then be notified with a new GiveUpEvent where the state is set to CANCELLED.
possDupHas been removed.
ApproveGiveUpReqDescriptionRequest to approve giveup request.Request to approve give-up request. The give-up request has been published to the member using GiveUpEvent.
possDupHas been removed.
RejectGiveUpReqDescriptionRequest to reject giveup request.Reject assigned or tripartite trade as receiver. The initiator will be notified by a GiveUpEvent on the GiveUp Event Flow.
possDupHas been removed.
AssignTradeWithTurnReqpossDupHas been removed.
TripartiteAllocationReqDescriptionRequest to tripartite allocation to a member.Tripartite allocation to another member. Tripartite agreement must exist. Tripartite requests that are not handled during the day are removed by the system.
possDupHas been removed.
TripartiteAllocationWithTurnReqpossDupHas been removed.
ModifyTradeSubAccountReqDescriptionModify Trade sub account request.To move a trade from house account to other house accounts.
possDupHas been removed.
AddCommissionReqpossDupHas been removed.
CancelCommissionReqpossDupHas been removed.
RejectCommissionReqpossDupHas been removed.

5.1 Trade Management Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
TradeResorigTradeIdDescriptionUsed to preserve the original trade id when original trade is being referenced in a subsequent trade transaction such as a transfer. For example when moving a trade this refers to the previous trade id. It works for moved/allocated trades as long as the new trade only consist of quantity from one trade. It does not work for aggregations since those trades comes from multiple trades. In case a trade is moved in multiple steps OrigTradeID points to the previous trade and not the initial trade.Used to preserve the original trade id when original trade is being referenced in a subsequent trade transaction such as a transfer. For example when moving a trade this refers to the previous trade id. It works for moved/allocated trades as long as the new trade only consist of quantity from one trade. It does not work for aggregations since those trades comes from multiple trades. In case a trade is moved in multiple steps origTradeID points to the previous trade and not the initial trade.
businessDateDescriptionBusiness date of the transaction according to the DWH domain. Table is partitioned by this attribute.Business date of the transaction according. The format is yyyy-MM-dd.
tradeDateDescriptionThe trade date of the trade according to the clearing domain.The trade date of the trade. The format is yyyy-MM-dd.
textDescriptionOptional free text field gotten from the deal -- TradeDestination.referenceOptional free text field from the reference of the original trade.
tradeTimestampDescriptionTrade time according to the clearing system.Trade time according to the clearing system. The format is yyyy-MM-ddTHH:mm:ss.SSS.
timeOfEntryDescriptionTrade time according to the Trading system.Trade time according to the Trading system. The format is yyyy-MM-ddTHH:mm:ss.SSS.
accountTypeDescriptionThe type of account for the tradeThe type of account for the trade. References name to constant PositionAccountType.
accountSubTypeDescriptionThe sub type of account for the tradeThe sub type of account for the trade. References name to constant PositionAccountSubType.
expirationDateDescriptionThe expirationDate of the instrumentThe expiry date of the instrument
assetClassallowedValuesAssetClass
assetSubClassallowedValuesAssetSubClass
agreedTimeDescriptionTime agreed between TM1 and TM2. Only applicable for reported trades.Time agreed between TM1 and TM2. Only applicable for reported trades. The format is yyyy-MM-ddTHH:mm:ss.SSS.
reportedTimeDescriptionThe time the reported trade was received on the trading system (system generated).The time the reported trade was received on the trading system (system generated). The format is yyyy-MM-ddTHH:mm:ss.SSS.
fromTradeIdDescriptionTo CS trade half IDTrade ID of original trade in case this tarde is created from a trade management activity.
fromAccountTypeDescriptionAccount Type of the From tradeAccount Type of the From trade. References name to constant PositionAccountType.
fromAccountSubTypeDescriptionAccount Sub Type of the From tradeAccount Sub Type of the From trade. References name to constant PositionAccountSubType.
positionIdHas been removed.
CommissionHas been removed.

6 Pricing Messages

7 Risk Messages

7.1 External Members

7.2 Clearing House

8 Settlement Messages

Message nameField nameAttribute nameChanged fromChanged to
GetSettlementInstructionsReqclearingMemberDescriptionThe requested clearing member.The requested clearing member ID.
settlementDateDescriptionThe requested settlement date.The requested settlement date. The format is yyyy-MM-dd.
possDupHas been removed.
ConfirmWithdrawalsReqDescriptionUsed for a CM to confirm or reject payment advices.Used for a Clearing Member to confirm or reject payment advices.
possDupHas been removed.
PaymentAdviceclearingMemberDescriptionSet on outbound messages.Clearing Member ID. Set on outbound messages.
GetPaymentAdvicesReqclearingMemberDescriptionThe clearing member.The clearing member ID.
settlementDateDescriptionThe settlement date.The settlement date. The format is yyyy-MM-dd.
possDupHas been removed.

8.1 Settlement Messages (Internal)

Message nameField nameAttribute nameChanged fromChanged to
SettlementInstructionDescriptionObject to hold a settlement instruction.Settlement instructions suitable to pass on to the settlement systems. The settlement instructions in RTC will be in state PENDING until settlement has been confirmed.
settlementDateDescriptionSettlement date.Settlement date. The format is yyyy-MM-dd.
senderBICDescriptionBIC code of the settlement bank of the paying member. Note that this can be the BIC of JSEӳ settlement bank.BIC code of the settlement bank of the paying member. Note that this can be the BIC of the settlement bank of JSE.
senderBranchDescriptionBranch no of the sender (used for swift).Branch no of the sender (used for SWIFT).
receiverBICDescriptionBIC code of the settlement bank of the receiving member. Note that this can be the BIC of JSEӳ settlement bank.BIC code of the settlement bank of the receiving member. Note that this can be the BIC of the settlement bank of JSE.
unconfirmedSettledAmountDescriptionThe sum of reported settled amounts that are waiting for confirmation on a position update in the Clearing domain.The sum of reported settled amounts that are waiting for confirmation on a position update.
settledAmountDescriptionAmount.The sum of reported settled amounts that have been matched to this instruction.

8.2 External Members

Message nameField nameAttribute nameChanged fromChanged to
GetRequestsForFXCollateralReqpossDupHas been removed.
RegisterFXCollateralReqvalueDateDescriptionThe requested value date.The requested value date. The format is yyyy-MM-dd.
clientIdDescriptionThe client id.The client ID.
tradingMemberIdDescriptionThe id of the Trading Member.The ID of the Trading Member.
clearingMemberIdDescriptionThe id of the Clearing Member.The ID of the Clearing Member.
possDupHas been removed.
SetCmBalancingStatusReqpossDupHas been removed.
SetWithdrawalConfirmStateForAllReqHas been removed.
SetWithdrawalConfirmStateForAllRspHas been removed.
8.2.1 External Members (Internal)
Message nameField nameAttribute nameChanged fromChanged to
FXCollateralcurrencyDescriptionAvailable Currency. The currency code according to ISO 4217.Available Currency. The alphabetic currency code according to ISO 4217.
possDupHas been removed.
FXCollateralStatuscurrencyDescriptionAvailable Currency. The currency code according to ISO 4217.Available Currency. The alphabetic currency code according to ISO 4217.
FxInterestRatecurrencyIdDescriptionID of the currency.ID of the currency. ISO 4217 alphabetic code.

8.3 Clearing House

9 Position Messages

9.1 External Members

9.2 Clearing House

10 Reference Data

10.1 General Messages

10.1.1 General Management Messages

Constant Groups

Constant group nameConstant nameAttribute nameChanged fromChanged to
PositionTypeSETTLEMENTDescriptionWhen a SETTLEMENT_SOURCE position is created, one or several positions of this type is also created in the instruments that represent the money and goods to be delivered.A position of type SETTLEMENT represents changed of the position on the settlement date.
PositionReasonALLOCATION_CORRECTION_TODescriptionThe deal origins from a move from one client account to another client account.The deal originates from a move from one client account to another client account.
PRINCIPAL_CORRECTION_TODescriptionThe deal origins from a move from a client account.The deal originates from a move from a client account.
ACCUMULATED_TODescriptionThe deal origins from a deal aggregation activity.The deal originates from a deal aggregation activity.
ASSIGNED_TODescriptionThe deal origins from a deal assign activity.The deal originates from a deal assign activity.
ASSIGN_CANCELLEDDescriptionThe deal assign cancelled by initator.The deal assign cancelled by initiator.
TRIPARTITE_FROMDescriptionThe deal has been assign using Tripartite agreement.The deal has been assigned using Tripartite agreement.
TRIPARTITE_WITH_TURN_FROMDescriptionThe deal has been assign with new price using Tripartite agreement.The deal has been assigned with new price using Tripartite agreement.
FlowStatesHas been removed.