ForeignExchangeTradeWithdrawalNotificationV03

fxtr.013.001.03

Scope The ForeignExchangeTradeWithdrawalNotification message is sent by a central system to notify the withdrawal of a foreign exchange trade which was previously notified to the receiver as an alleged trade. Usage The ForeignExchangeTradeWithdrawalNotification message is used to confirm the cancellation of a previously notified trade.

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% ForeignExchangeTradeWithdrawalNotificationV03 recursion level 0 with max 0
class ForeignExchangeTradeWithdrawalNotificationV03{
    MessageIdentification IsoMax35Text
    MatchingSystemUniqueReference IsoMax35Text
    SettlementSessionIdentifier IsoExact4AlphaNumericText
}
ForeignExchangeTradeWithdrawalNotificationV03 *-- "0..1" WithdrawalReason1 : WithdrawalReason
ForeignExchangeTradeWithdrawalNotificationV03 *-- "0..1" SupplementaryData1 : SupplementaryData
  

Now, we will zero-in one-by-one on each of these building blocks.

MessageIdentification building block

Identification of the present message assigned by the party issuing the message. This identification must be unique amongst all messages of same type sent by the same party. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

MatchingSystemUniqueReference building block

Reference to the unique system identification assigned to the trade by the central matching system. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

WithdrawalReason building block

Reason for the withdrawal notification. Specifies the withdrawal reason code and optionally a withdrawal reason sub code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% WithdrawalReason1 recursion level 0 with max 1
class WithdrawalReason1{
    WithdrawalReasonCode WithdrawalReason1Code
    WithdrawalReasonSubCode IsoMax4Text
}
  

WithdrawalReason1 members

SettlementSessionIdentifier building block

To indicate the requested CLS Settlement Session that the related trade is part of. Specifies an alphanumeric string with a length of 4 characters. For comparison, see the ISO20022 official specification This message is declared as Exact4AlphaNumericText in the ISO specification. In our implementation, it is represented in source code as IsoExact4AlphaNumericText. Due to global using directives, it is treated as a System.String by the compiler and runtime.

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
  

SupplementaryData1 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the ForeignExchangeTradeWithdrawalNotificationV03 implementation follows a specific implementaiton pattern. First of all, ForeignExchangeTradeWithdrawalNotificationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ForeignExchangeTradeWithdrawalNotificationV03Document implements IOuterDocument. Because ForeignExchangeTradeWithdrawalNotificationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ForeignExchangeTradeWithdrawalNotificationV03.

classDiagram
    class IOuterRecord
    ForeignExchangeTradeWithdrawalNotificationV03 --|> IOuterRecord : Implements
    ForeignExchangeTradeWithdrawalNotificationV03Document --|> IOuterDocument~ForeignExchangeTradeWithdrawalNotificationV03~ : Implements
    class IOuterDocument~ForeignExchangeTradeWithdrawalNotificationV03~ {
        ForeignExchangeTradeWithdrawalNotificationV03 Message
     }
  

Document wrapper for serialization

The only real purpose ForeignExchangeTradeWithdrawalNotificationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:fxtr.013.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ForeignExchangeTradeWithdrawalNotificationV03.ToDocument() method. The returned ForeignExchangeTradeWithdrawalNotificationV03Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ForeignExchangeTradeWithdrawalNotificationV03Document *-- ForeignExchangeTradeWithdrawalNotificationV03 : Document
  

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:fxtr.013.001.03">
    <FXTradWdrwlNtfctn>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <MtchgSysUnqRef>
            <!-- MatchingSystemUniqueReference inner content -->
        </MtchgSysUnqRef>
        <WdrwlRsn>
            <!-- WithdrawalReason inner content -->
        </WdrwlRsn>
        <SttlmSsnIdr>
            <!-- SettlementSessionIdentifier inner content -->
        </SttlmSsnIdr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FXTradWdrwlNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_K7tXYS53EeKwTrPDLMbLxA"
  name="ForeignExchangeTradeWithdrawalNotificationV03"
  definition="Scope&#xD;&#xA;The ForeignExchangeTradeWithdrawalNotification message is sent by a central system to notify the withdrawal of a foreign exchange trade which was previously notified to the receiver as an alleged trade.&#xD;&#xA;Usage&#xD;&#xA;The ForeignExchangeTradeWithdrawalNotification message is used to confirm the cancellation of a previously notified trade."
  registrationStatus="Registered"
  messageSet="_nB3wITJaEeOX98kTVpuqCw _wiatARJsEeSstbhSoCHcWw"
  xmlTag="FXTradWdrwlNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_oEmmtzqMEeKXK8qRvydwAw"
    name="MessageIdentification"
    definition="Identification of the present message assigned by the party issuing the message. This identification must be unique amongst all messages of same type sent by the same party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_g9h2VTqMEeKXK8qRvydwAw"
    name="MatchingSystemUniqueReference"
    definition="Reference to the unique system identification assigned to the trade by the central matching system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MtchgSysUnqRef"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_eHZflZEkEeKcLcxonNWTXg"
    name="WithdrawalReason"
    definition="Reason for the withdrawal notification."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="WdrwlRsn"
    complexType="_t1jau4xnEeKdxfnzD2sqyA" />
  <messageBuildingBlock
    xmi:id="_QVqk05TkEeKShbaq9ixROw"
    name="SettlementSessionIdentifier"
    definition="To indicate the requested CLS Settlement Session that the related trade is part of."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SttlmSsnIdr"
    simpleType="_YYLJ6Np-Ed-ak6NoX_4Aeg_-1265890753" />
  <messageBuildingBlock
    xmi:id="_GJJnaS53EeKwTrPDLMbLxA"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="fxtr"
    messageFunctionality="013"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.