SettlementReportingInitiationV02

casr.001.001.02

The SettlementReportingInitiation message is usually sent by an agent (processor, clearing or settlement agent) to an acquirer, agent or issuer to inform about financial totals already settled or to be settled issued as an outcome of the clearing process.

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
%% SettlementReportingInitiationV02 recursion level 0 with max 0
SettlementReportingInitiationV02 *-- "1..1" Header66 : Header
SettlementReportingInitiationV02 *-- "1..1" SettlementReportingInitiation2 : Body
SettlementReportingInitiationV02 *-- "0..1" ContentInformationType20 : SecurityTrailer
  

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

Header building block

Information related to the management of the protocol. Set of characteristics related to the protocol. Header for a fee collection message. ISO 8583 MTI For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header66 recursion level 0 with max 1
class Header66{
    MessageFunction MessageFunction29Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header66 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header66 *-- "1..1" GenericIdentification183 : InitiatingParty
Header66 *-- "0..1" GenericIdentification183 : RecipientParty
Header66 *-- "0..0" AdditionalData1 : TraceData
Header66 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification
  

Header66 members

Body building block

Information related to the initiation of the settlement. Information related to the settlement initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SettlementReportingInitiation2 recursion level 0 with max 1
SettlementReportingInitiation2 *-- "1..1" Environment27 : Environment
SettlementReportingInitiation2 *-- "0..1" Context17 : Context
SettlementReportingInitiation2 *-- "1..1" Transaction138 : Transaction
SettlementReportingInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
SettlementReportingInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment27 recursion level 1 with max 1
Environment27 *-- "0..1" PartyIdentification263 : SettlementInstitution
Environment27 *-- "0..1" PartyIdentification263 : Originator
Environment27 *-- "0..1" PartyIdentification263 : Sender
Environment27 *-- "0..1" PartyIdentification263 : Receiver
Environment27 *-- "0..1" PartyIdentification263 : Destination
Environment27 *-- "0..1" FinancialInstitution6 : FinancialInstitution
Environment27 *-- "0..1" PartyIdentification258 : OtherInstitution
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction138 recursion level 1 with max 1
class Transaction138{
    SettlementReportType SettlementReportType1Code
    OtherSettlementReportType IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    TransactionDescription IsoMax1000Text
}
Transaction138 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction138 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction138 *-- "0..1" SettlementTotals2 : SettlementTotals
Transaction138 *-- "0..1" Amount17 : FundsTransferAmount
Transaction138 *-- "0..0" AdditionalData1 : AdditionalData
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
    ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

SettlementReportingInitiation2 members

SecurityTrailer building block

Trailer of the message containing a MAC General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
    MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
    Control IsoExact1HexBinaryText
    KeySetIdentifier IsoMax8NumericText
    DerivedInformation IsoMax32HexBinaryText
    Algorithm IsoMax2NumericText
    KeyLength IsoMax4NumericText
    KeyProtection IsoMax2NumericText
    KeyIndex IsoMax5NumericText
    PaddingMethod IsoMax2NumericText
    InitialisationVector IsoMax32HexBinaryText
}
  

ContentInformationType20 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SettlementReportingInitiationV02 --|> IOuterRecord : Implements
    SettlementReportingInitiationV02Document --|> IOuterDocument~SettlementReportingInitiationV02~ : Implements
    class IOuterDocument~SettlementReportingInitiationV02~ {
        SettlementReportingInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SettlementReportingInitiationV02Document *-- SettlementReportingInitiationV02 : 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:casr.001.001.02">
    <SttlmRptgInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </SttlmRptgInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_UMfMZMr9EeuNe7RtB4qFHw"
  name="SettlementReportingInitiationV02"
  definition="The SettlementReportingInitiation message is usually sent by an agent (processor, clearing or settlement agent) to an acquirer, agent or issuer to inform about financial totals already settled or to be settled issued as an outcome of the clearing process."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="SttlmRptgInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_UMfMZsr9EeuNe7RtB4qFHw"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_aRA58RynEeyVgKPonV4SjQ" />
  <messageBuildingBlock
    xmi:id="_UMfMZ8r9EeuNe7RtB4qFHw"
    name="Body"
    definition="Information related to the initiation of the settlement."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_dZDlAYwEEeuC5632vxUfGg" />
  <messageBuildingBlock
    xmi:id="_UMfMZcr9EeuNe7RtB4qFHw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="casr"
    messageFunctionality="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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