ForeignExchangeTradeCaptureReportAcknowledgementV01

fxtr.033.001.01

Scope The ForeignExchangeTradeCaptureReportAcknowledgement message is sent by trading members to the trading system for notifying the trade capture report is received.

Usage The acknowledgement is sent by the trading member to the trading system after they received the trade capture report. Note that one capture acknowledgement responds to one capture report.

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
%% ForeignExchangeTradeCaptureReportAcknowledgementV01 recursion level 0 with max 0
class ForeignExchangeTradeCaptureReportAcknowledgementV01{
    TradeIdentification IsoMax35Text
    Status Status5Code
}
ForeignExchangeTradeCaptureReportAcknowledgementV01 *-- "0..1" MessageIdentification1 : AcknowledgementIdentification
ForeignExchangeTradeCaptureReportAcknowledgementV01 *-- "0..1" AdditionalReferences : Reference
ForeignExchangeTradeCaptureReportAcknowledgementV01 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

AcknowledgementIdentification building block

Identifies the acknowledgement message. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

TradeIdentification building block

Unique reference identification assigned to the trade by the instructing party. This reference will be used throughout the trade life cycle to identify the particular trade. 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.

Status building block

Acknowlegement status of recevied trade capture report. Specifies the status of an instruction. For comparison, see the ISO20022 official specification This message is declared as Status5Code in the ISO specification. In our implementation, it is represented in source code as Status5Code. Due to global using directives, it is treated as a System.String by the compiler and runtime.

Reference building block

Reference of the acknowledge, specifies the message this acknowledge responds to. Business reference(s) to one or more relevant messages previously sent by other parties, or by the same party issuing this message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReferences recursion level 0 with max 1
class AdditionalReferences{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReferences *-- "0..1" PartyIdentification : ReferenceIssuer
%% PartyIdentification recursion level 1 with max 1
class PartyIdentification{
    Name IsoMax35Text
}
  

AdditionalReferences members

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 ForeignExchangeTradeCaptureReportAcknowledgementV01 implementation follows a specific implementaiton pattern. First of all, ForeignExchangeTradeCaptureReportAcknowledgementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ForeignExchangeTradeCaptureReportAcknowledgementV01Document implements IOuterDocument. Because ForeignExchangeTradeCaptureReportAcknowledgementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ForeignExchangeTradeCaptureReportAcknowledgementV01.

classDiagram
    class IOuterRecord
    ForeignExchangeTradeCaptureReportAcknowledgementV01 --|> IOuterRecord : Implements
    ForeignExchangeTradeCaptureReportAcknowledgementV01Document --|> IOuterDocument~ForeignExchangeTradeCaptureReportAcknowledgementV01~ : Implements
    class IOuterDocument~ForeignExchangeTradeCaptureReportAcknowledgementV01~ {
        ForeignExchangeTradeCaptureReportAcknowledgementV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ForeignExchangeTradeCaptureReportAcknowledgementV01Document *-- ForeignExchangeTradeCaptureReportAcknowledgementV01 : 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.033.001.01">
    <FXTradCaptrRptAck>
        <AckId>
            <!-- AcknowledgementIdentification inner content -->
        </AckId>
        <TradId>
            <!-- TradeIdentification inner content -->
        </TradId>
        <Sts>
            <!-- Status inner content -->
        </Sts>
        <Ref>
            <!-- Reference inner content -->
        </Ref>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FXTradCaptrRptAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_5_POYHO0EeSG-OV0nXMl5w"
  name="ForeignExchangeTradeCaptureReportAcknowledgementV01"
  definition="Scope&#xD;&#xA;The ForeignExchangeTradeCaptureReportAcknowledgement message is sent by trading members to the trading system for notifying the trade capture report is received.&#xD;&#xA;&#xD;&#xA;Usage&#xD;&#xA;The acknowledgement is sent by the trading member to the trading system after they received the trade capture report. &#xD;&#xA;Note that one capture acknowledgement responds to one capture report."
  registrationStatus="Registered"
  messageSet="_zO-IIQRGEeWRS-48_sRZxQ"
  xmlTag="FXTradCaptrRptAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_BoI5cHO1EeSG-OV0nXMl5w"
    name="AcknowledgementIdentification"
    definition="Identifies the acknowledgement message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="AckId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_EnLdcHO1EeSG-OV0nXMl5w"
    name="TradeIdentification"
    definition="Unique reference identification assigned to the trade by the instructing party. This reference will be used throughout the trade life cycle to identify the particular trade."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TradId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_I7vC4HO1EeSG-OV0nXMl5w"
    name="Status"
    definition="Acknowlegement status of recevied trade capture report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Sts"
    simpleType="_Yaalktp-Ed-ak6NoX_4Aeg_-277478982" />
  <messageBuildingBlock
    xmi:id="_OS-0YHO1EeSG-OV0nXMl5w"
    name="Reference"
    definition="Reference of the acknowledge, specifies the message this acknowledge responds to."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Ref"
    complexType="_Rca4sNp-Ed-ak6NoX_4Aeg_-583688066" />
  <messageBuildingBlock
    xmi:id="_ankbAKHiEeS69KkQis5bYg"
    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="033"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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