TransactionReportRequestV03

tsmt.042.001.03

Scope The TransactionReportRequest message is sent by a party involved in a transaction to the matching application. This message is used to request a report on details of transactions registered in the matching application. Usage The TransactionReportRequest message can be sent by either party involved in a transaction to request a report on a variety of details of all transactions that the requester is involved in. For example, the message can be used to request a report on all transactions that the requester is involved in with a certain customer.

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
%% TransactionReportRequestV03 recursion level 0 with max 0
TransactionReportRequestV03 *-- "1..1" MessageIdentification1 : RequestIdentification
TransactionReportRequestV03 *-- "1..1" ReportSpecification4 : ReportSpecification
  

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

RequestIdentification building block

Identifies the request 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

ReportSpecification building block

Parameters to be used as criteria for the content of the transaction report. Specifies the parameters for which a transaction report must be generated. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReportSpecification4 recursion level 0 with max 1
class ReportSpecification4{
    TransactionIdentification IsoMax35Text
    SubmitterTransactionReference IsoMax35Text
    BuyerCountry CountryCode
    SellerCountry CountryCode
    CorrespondentCountry CountryCode
}
ReportSpecification4 *-- "0..0" TransactionStatus4 : TransactionStatus
ReportSpecification4 *-- "0..0" BICIdentification1 : EntitiesToBeReported
ReportSpecification4 *-- "0..0" BICIdentification1 : Correspondent
ReportSpecification4 *-- "0..0" BICIdentification1 : SubmittingBank
ReportSpecification4 *-- "0..0" BICIdentification1 : ObligorBank
ReportSpecification4 *-- "0..0" PartyIdentification28 : Buyer
ReportSpecification4 *-- "0..0" PartyIdentification28 : Seller
ReportSpecification4 *-- "0..0" PendingActivity1 : PendingRequestForAction
%% TransactionStatus4 recursion level 1 with max 1
class TransactionStatus4{
    Status BaselineStatus3Code
}
%% 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
}
%% PartyIdentification28 recursion level 1 with max 1
class PartyIdentification28{
    Name IsoMax70Text
}
PartyIdentification28 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
%% PartyIdentification28 recursion level 1 with max 1
class PartyIdentification28{
    Name IsoMax70Text
}
PartyIdentification28 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
%% PendingActivity1 recursion level 1 with max 1
class PendingActivity1{
    Type Action1Code
    Description IsoMax140Text
}
  

ReportSpecification4 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransactionReportRequestV03 --|> IOuterRecord : Implements
    TransactionReportRequestV03Document --|> IOuterDocument~TransactionReportRequestV03~ : Implements
    class IOuterDocument~TransactionReportRequestV03~ {
        TransactionReportRequestV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    TransactionReportRequestV03Document *-- TransactionReportRequestV03 : 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.042.001.03">
    <TxRptReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <RptSpcfctn>
            <!-- ReportSpecification inner content -->
        </RptSpcfctn>
    </TxRptReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_15W1yNE8Ed-BzquC8wXy7w_-2039439363"
  name="TransactionReportRequestV03"
  definition="Scope&#xD;&#xA;The TransactionReportRequest message is sent by a party involved in a transaction to the matching application.&#xD;&#xA;This message is used to request a report on details of transactions registered in the matching application.&#xD;&#xA;Usage&#xD;&#xA;The TransactionReportRequest message can be sent by either party involved in a transaction to request a report on a variety of details of all transactions that the requester is involved in. For example, the message can be used to request a report on all transactions that the requester is involved in with a certain customer."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="TxRptReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_15W1ydE8Ed-BzquC8wXy7w_-2039438961"
    name="RequestIdentification"
    definition="Identifies the request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_15W1ytE8Ed-BzquC8wXy7w_-2039439323"
    name="ReportSpecification"
    definition="Parameters to be used as criteria for the content of the transaction report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptSpcfctn"
    complexType="_PcRl4dp-Ed-ak6NoX_4Aeg_1375759875" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="042"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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