TransactionReportV03

tsmt.041.001.03

Scope The TransactionReport message is sent by the matching application to the requester of a transaction report. This message is used to report on various details of transactions registered in the matching application. Usage The TransactionReport message can be sent by the matching application to report on various details of transactions that the requester of the report asked for. The message is sent in response to a TransactionReportRequest message.

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
%% TransactionReportV03 recursion level 0 with max 0
TransactionReportV03 *-- "1..1" MessageIdentification1 : ReportIdentification
TransactionReportV03 *-- "1..1" MessageIdentification1 : RelatedMessageReference
TransactionReportV03 *-- "0..1" TransactionReportItems3 : ReportedItems
  

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

ReportIdentification building block

Identifies the report. 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

RelatedMessageReference building block

Reference to the previous message requesting the report. 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

ReportedItems building block

Detailed description of the items that correspond to the parameters set in the request. Detailed description of the items that correspond to the parameters set in a request and for which a report has been generated. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionReportItems3 recursion level 0 with max 1
class TransactionReportItems3{
    TransactionIdentification IsoMax35Text
    BuyerBankCountry CountryCode
    SellerBankCountry CountryCode
    OutstandingAmount IsoCurrencyAndAmount
    TotalNetAmount IsoCurrencyAndAmount
}
TransactionReportItems3 *-- "0..1" DocumentIdentification3 : EstablishedBaselineIdentification
TransactionReportItems3 *-- "1..1" TransactionStatus4 : TransactionStatus
TransactionReportItems3 *-- "0..2" DocumentIdentification5 : UserTransactionReference
TransactionReportItems3 *-- "1..1" DocumentIdentification7 : PurchaseOrderReference
TransactionReportItems3 *-- "1..1" PartyIdentification26 : Buyer
TransactionReportItems3 *-- "1..1" PartyIdentification26 : Seller
TransactionReportItems3 *-- "1..1" BICIdentification1 : BuyerBank
TransactionReportItems3 *-- "1..1" BICIdentification1 : SellerBank
TransactionReportItems3 *-- "0..0" BICIdentification1 : ObligorBank
TransactionReportItems3 *-- "0..0" BICIdentification1 : SubmittingBank
TransactionReportItems3 *-- "0..0" PendingActivity2 : PendingRequestForAction
%% DocumentIdentification3 recursion level 1 with max 1
class DocumentIdentification3{
    Identification IsoMax35Text
    Version IsoNumber
}
%% TransactionStatus4 recursion level 1 with max 1
class TransactionStatus4{
    Status BaselineStatus3Code
}
%% DocumentIdentification5 recursion level 1 with max 1
class DocumentIdentification5{
    Identification IsoMax35Text
}
DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer
%% DocumentIdentification7 recursion level 1 with max 1
class DocumentIdentification7{
    Identification IsoMax35Text
    DateOfIssue IsoISODate
}
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% PartyIdentification26 recursion level 1 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% PendingActivity2 recursion level 1 with max 1
class PendingActivity2{
    Type Action2Code
    Description IsoMax140Text
}
  

TransactionReportItems3 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransactionReportV03 --|> IOuterRecord : Implements
    TransactionReportV03Document --|> IOuterDocument~TransactionReportV03~ : Implements
    class IOuterDocument~TransactionReportV03~ {
        TransactionReportV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    TransactionReportV03Document *-- TransactionReportV03 : 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:tsmt.041.001.03">
    <TxRpt>
        <RptId>
            <!-- ReportIdentification inner content -->
        </RptId>
        <RltdMsgRef>
            <!-- RelatedMessageReference inner content -->
        </RltdMsgRef>
        <RptdItms>
            <!-- ReportedItems inner content -->
        </RptdItms>
    </TxRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_2UxmeNE8Ed-BzquC8wXy7w_-1389761233"
  name="TransactionReportV03"
  definition="Scope&#xD;&#xA;The TransactionReport message is sent by the matching application to the requester of a transaction report.&#xD;&#xA;This message is used to report on various details of transactions registered in the matching application.&#xD;&#xA;Usage&#xD;&#xA;The TransactionReport message can be sent by the matching application to report on various details of transactions that the requester of the report asked for. The message is sent in response to a TransactionReportRequest message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="TxRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_2UxmedE8Ed-BzquC8wXy7w_-1389761119"
    name="ReportIdentification"
    definition="Identifies the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_2U6wYNE8Ed-BzquC8wXy7w_-1389760800"
    name="RelatedMessageReference"
    definition="Reference to the previous message requesting the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RltdMsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_2U6wYdE8Ed-BzquC8wXy7w_-1389761189"
    name="ReportedItems"
    definition="Detailed description of the items that correspond to the parameters set in the request."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="RptdItms"
    complexType="_Pcav1tp-Ed-ak6NoX_4Aeg_-340644138" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="041"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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