SettlementReportingInitiationV01

casr.001.001.01

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
%% SettlementReportingInitiationV01 recursion level 0 with max 0
SettlementReportingInitiationV01 *-- "1..1" Header48 : Header
SettlementReportingInitiationV01 *-- "1..1" SettlementReportingInitiation1 : Body
SettlementReportingInitiationV01 *-- "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
%% Header48 recursion level 0 with max 1
class Header48{
    MessageFunction MessageFunction29Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header48 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header48 *-- "1..1" GenericIdentification172 : InitiatingParty
Header48 *-- "0..1" GenericIdentification172 : RecipientParty
Header48 *-- "0..0" AdditionalData1 : TraceData
Header48 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
  

Header48 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
%% SettlementReportingInitiation1 recursion level 0 with max 1
SettlementReportingInitiation1 *-- "1..1" Environment9 : Environment
SettlementReportingInitiation1 *-- "0..1" Context6 : Context
SettlementReportingInitiation1 *-- "1..1" Transaction104 : Transaction
SettlementReportingInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
SettlementReportingInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment9 recursion level 1 with max 1
Environment9 *-- "0..1" PartyIdentification197 : SettlementInstitution
Environment9 *-- "0..1" PartyIdentification197 : Sender
Environment9 *-- "0..1" PartyIdentification197 : Receiver
Environment9 *-- "0..1" FinancialInstitution5 : FinancialInstitution
Environment9 *-- "0..1" PartyIdentification197 : OtherInstitution
%% Context6 recursion level 1 with max 1
Context6 *-- "0..1" TransactionContext6 : TransactionContext
%% Transaction104 recursion level 1 with max 1
class Transaction104{
    SettlementReportType SettlementReportType1Code
    OtherSettlementReportType IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction104 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction104 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction104 *-- "0..1" SettlementTotals1 : SettlementTotals
Transaction104 *-- "0..1" Amount14 : FundsTransferAmount
Transaction104 *-- "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
  

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

classDiagram
    class IOuterRecord
    SettlementReportingInitiationV01 --|> IOuterRecord : Implements
    SettlementReportingInitiationV01Document --|> IOuterDocument~SettlementReportingInitiationV01~ : Implements
    class IOuterDocument~SettlementReportingInitiationV01~ {
        SettlementReportingInitiationV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SettlementReportingInitiationV01Document *-- SettlementReportingInitiationV01 : 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.01">
    <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="_Vc1ZVVcvEeeFltjJxERUxw"
  name="SettlementReportingInitiationV01"
  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="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="SttlmRptgInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Vc1ZVlcvEeeFltjJxERUxw"
    nextVersions="_tme-43a1Eeef9c2nwgY9Xw"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_wmyN8VaGEeeFltjJxERUxw" />
  <messageBuildingBlock
    xmi:id="_Vc1ZWVcvEeeFltjJxERUxw"
    nextVersions="_tme-5Xa1Eeef9c2nwgY9Xw"
    name="Body"
    definition="Information related to the initiation of the settlement."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_CQCF4VcyEeeFltjJxERUxw" />
  <messageBuildingBlock
    xmi:id="_Vc1ZV1cvEeeFltjJxERUxw"
    nextVersions="_tme-53a1Eeef9c2nwgY9Xw"
    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="01" />
</messageDefinition>

ISO Building Blocks

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