auth.100.001.01
The SettlementFailsMonthlyReport is sent by central securities depository or by a central bank operating a securities settlement system to the CSD competent authority in its jurisdiction, to provide monthly and daily aggregated data on the number and the nature of settlement instructions which failed to settle on their intended settlement day. The report contains monthly and daily statistical information on the number and value of overall settlement instructions, settled instructions, and settlement fails that occurred during a specified period and within a given securities settlement system.
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 %% SettlementFailsMonthlyReportV01 recursion level 0 with max 0 SettlementFailsMonthlyReportV01 *-- "1..1" SettlementFailsReportHeader2 : ReportHeader SettlementFailsMonthlyReportV01 *-- "1..1" SettlementFailsData3 : MonthlyAggregate SettlementFailsMonthlyReportV01 *-- "1..1" SettlementFailsDailyData3 : DailyData SettlementFailsMonthlyReportV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
ReportHeader building block
Specifies parameters of the report. Specifies parameters of the report. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SettlementFailsReportHeader2 recursion level 0 with max 1 class SettlementFailsReportHeader2{ CreationDateTime IsoISODateTime Currency ActiveCurrencyCode ReportStatus TransactionOperationType4Code } SettlementFailsReportHeader2 *-- "1..1" DatePeriod2 : ReportingPeriod SettlementFailsReportHeader2 *-- "1..1" SecuritiesSettlementSystemIdentification2 : SecuritiesSettlementSystem %% DatePeriod2 recursion level 1 with max 1 class DatePeriod2{ FromDate IsoISODate ToDate IsoISODate } %% SecuritiesSettlementSystemIdentification2 recursion level 1 with max 1 class SecuritiesSettlementSystemIdentification2{ SystemIdentification IsoMax35Text SystemName IsoMax140Text CountryOfJurisdiction CountryCode CSDLegalName IsoMax140Text LEI IsoLEIIdentifier } SecuritiesSettlementSystemIdentification2 *-- "0..0" Contact9 : ResponsibleParty
SettlementFailsReportHeader2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
CreationDateTime | Provides the reporting timestamp, when the report was submitted from the CSD to the Competent Authority. | IsoISODateTime - Required 1..1 |
ReportingPeriod | Period covered by the report. | DatePeriod2 - Required 1..1 |
Currency | Specifies the currency used to report the aggregated values of the transactions. Usage: this is the currency in which the values have to be reported, when no explicit currency is provided. | ActiveCurrencyCode - Required 1..1 |
ReportStatus | Provides the status of the report. | TransactionOperationType4Code - Required 1..1 |
SecuritiesSettlementSystem | Specifies the securities settlement system used in a settlement process. | SecuritiesSettlementSystemIdentification2 - Required 1..1 |
MonthlyAggregate building block
Aggregated monthly volume and value of settled, failed, total of failed settlement instructions performed during the period covered by the report, for financial instruments, types of transactions, types of clients and cash transfers. Specifies the aggregated data of settlement fails instructions. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SettlementFailsData3 recursion level 0 with max 1 SettlementFailsData3 *-- "1..1" SettlementTotalData1 : Total SettlementFailsData3 *-- "0..1" SettlementFailsParticipantRange1 : ParticipantInFail SettlementFailsData3 *-- "0..0" SettlementFailsCurrency2 : FailsPerCurrency SettlementFailsData3 *-- "0..1" SettlementFailsInstrument2 : FailsPerFinancialInstrumentType SettlementFailsData3 *-- "0..1" SettlementFailsSecuritiesRange1 : SecuritiesInFail SettlementFailsData3 *-- "0..1" SettlementFailsTransactionType2 : FailsPerTransactionType SettlementFailsData3 *-- "0..1" SettlementDataVolume2 : TotalSettlementPenalties SettlementFailsData3 *-- "1..1" SettlementFailureReason3 : FailureReason %% SettlementTotalData1 recursion level 1 with max 1 SettlementTotalData1 *-- "1..1" SettlementDataVolume2 : Settled SettlementTotalData1 *-- "1..1" SettlementDataVolume2 : Failed SettlementTotalData1 *-- "1..1" SettlementDataVolume2 : Total SettlementTotalData1 *-- "1..1" SettlementDataRate2 : FailedRate %% SettlementFailsParticipantRange1 recursion level 1 with max 1 SettlementFailsParticipantRange1 *-- "1..0" SettlementFailsParticipant1 : HighestInVolume SettlementFailsParticipantRange1 *-- "1..0" SettlementFailsParticipant1 : HighestInValue %% SettlementFailsCurrency2 recursion level 1 with max 1 class SettlementFailsCurrency2{ Currency ActiveCurrencyCode } SettlementFailsCurrency2 *-- "1..1" SettlementTotalData1 : Data %% SettlementFailsInstrument2 recursion level 1 with max 1 SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : Equity SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : SovereignDebt SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : Bond SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : OtherTransferableSecurities SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : ExchangeTradedFunds SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : CollectiveInvestmentUndertakings SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : MoneyMarketInstrument SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : EmissionAllowance SettlementFailsInstrument2 *-- "1..1" ISettlementTotalData1Choice : Other %% SettlementFailsSecuritiesRange1 recursion level 1 with max 1 SettlementFailsSecuritiesRange1 *-- "1..0" SettlementFailsSecurities1 : HighestInVolume SettlementFailsSecuritiesRange1 *-- "1..0" SettlementFailsSecurities1 : HighestInValue %% SettlementFailsTransactionType2 recursion level 1 with max 1 SettlementFailsTransactionType2 *-- "1..1" ISettlementTotalData1Choice : SecuritiesBuyOrSell SettlementFailsTransactionType2 *-- "1..1" ISettlementTotalData1Choice : CollateralManagementOperation SettlementFailsTransactionType2 *-- "1..1" ISettlementTotalData1Choice : SecuritiesLendingOrBorrowing SettlementFailsTransactionType2 *-- "1..1" ISettlementTotalData1Choice : RepurchaseAgreement SettlementFailsTransactionType2 *-- "1..1" ISettlementTotalData1Choice : Other %% SettlementDataVolume2 recursion level 1 with max 1 class SettlementDataVolume2{ Volume IsoMax20PositiveNumber Value IsoMax20PositiveDecimalNumber } %% SettlementFailureReason3 recursion level 1 with max 1 class SettlementFailureReason3{ AverageDuration IsoMax2Fraction1NonNegativeNumber } SettlementFailureReason3 *-- "1..0" SettlementFailureReason2 : Description
SettlementFailsData3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Total | Total of all types of settlement transactions. | SettlementTotalData1 - Required 1..1 |
ParticipantInFail | Further details on the central securities depositories participants with the highest rates of settlement fails. | SettlementFailsParticipantRange1 - Optional 0..1 |
FailsPerCurrency | Further details on the settlement fails per currency. | SettlementFailsCurrency2 - Unknown 0..0 |
FailsPerFinancialInstrumentType | Further details on the settlement fails per financial instrument type. | SettlementFailsInstrument2 - Optional 0..1 |
SecuritiesInFail | Further details on the securities with the highest rates of settlement fails. | SettlementFailsSecuritiesRange1 - Optional 0..1 |
FailsPerTransactionType | Further details on the settlement fails per transaction type. | SettlementFailsTransactionType2 - Optional 0..1 |
TotalSettlementPenalties | Total of all types of settlement penalties (such as total of late matching and settlement fails). | SettlementDataVolume2 - Optional 0..1 |
FailureReason | Further details on the reason for the settlement fails. | SettlementFailureReason3 - Required 1..1 |
DailyData building block
Daily data volume and value of settled, failed, total of failed settlement instructions performed during the period covered by the report, for financial instruments, types of transactions, types of clients and cash transfers. Specifies the details for a specific date on the daily data on settlement fails instructions. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SettlementFailsDailyData3 recursion level 0 with max 1 class SettlementFailsDailyData3{ ReportingDate IsoISODate } SettlementFailsDailyData3 *-- "1..1" SettlementFailsDailyInstrument3 : DailyRecord %% SettlementFailsDailyInstrument3 recursion level 1 with max 1 SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : Equity SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : SovereignDebt SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : Bond SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : OtherTransferableSecurities SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : ExchangeTradedFunds SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : CollectiveInvestmentUndertakings SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : MoneyMarketInstrument SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : EmissionAllowance SettlementFailsDailyInstrument3 *-- "1..1" ISettlementFailsDailyTransactionType1Choice : Other
SettlementFailsDailyData3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
ReportingDate | Date for each reporting day in the month. | IsoISODate - Required 1..1 |
DailyRecord | Data related to the failed settlement instructions for the reporting date. | SettlementFailsDailyInstrument3 - Required 1..1 |
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
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the SettlementFailsMonthlyReportV01 implementation follows a specific implementaiton pattern. First of all, SettlementFailsMonthlyReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SettlementFailsMonthlyReportV01Document implements IOuterDocument. Because SettlementFailsMonthlyReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SettlementFailsMonthlyReportV01.
classDiagram class IOuterRecord SettlementFailsMonthlyReportV01 --|> IOuterRecord : Implements SettlementFailsMonthlyReportV01Document --|> IOuterDocument~SettlementFailsMonthlyReportV01~ : Implements class IOuterDocument~SettlementFailsMonthlyReportV01~ { SettlementFailsMonthlyReportV01 Message }
Document wrapper for serialization
The only real purpose SettlementFailsMonthlyReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.100.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SettlementFailsMonthlyReportV01.ToDocument() method. The returned SettlementFailsMonthlyReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram SettlementFailsMonthlyReportV01Document *-- SettlementFailsMonthlyReportV01 : 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:auth.100.001.01">
<SttlmFlsMnthlyRpt>
<RptHdr>
<!-- ReportHeader inner content -->
</RptHdr>
<MnthlyAggt>
<!-- MonthlyAggregate inner content -->
</MnthlyAggt>
<DalyData>
<!-- DailyData inner content -->
</DalyData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</SttlmFlsMnthlyRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_pq7TuUEXEeqXB_DgAcRqgw"
name="SettlementFailsMonthlyReportV01"
definition="The SettlementFailsMonthlyReport is sent by central securities depository or by a central bank operating a securities settlement system to the CSD competent authority in its jurisdiction, to provide monthly and daily aggregated data on the number and the nature of settlement instructions which failed to settle on their intended settlement day. The report contains monthly and daily statistical information on the number and value of overall settlement instructions, settled instructions, and settlement fails that occurred during a specified period and within a given securities settlement system."
registrationStatus="Registered"
messageSet="_t2waJMTEEem1btCrV7DGXw"
xmlTag="SttlmFlsMnthlyRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_pq7Tu0EXEeqXB_DgAcRqgw"
name="ReportHeader"
definition="Specifies parameters of the report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptHdr"
complexType="_h8xRgR2yEeqF2P5v-Rtejg" />
<messageBuildingBlock
xmi:id="_pq7TvUEXEeqXB_DgAcRqgw"
name="MonthlyAggregate"
definition="Aggregated monthly volume and value of settled, failed, total of failed settlement instructions performed during the period covered by the report, for financial instruments, types of transactions, types of clients and cash transfers."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MnthlyAggt"
complexType="_afLKcR2lEeqF2P5v-Rtejg" />
<messageBuildingBlock
xmi:id="_pq7Tv0EXEeqXB_DgAcRqgw"
name="DailyData"
definition="Daily data volume and value of settled, failed, total of failed settlement instructions performed during the period covered by the report, for financial instruments, types of transactions, types of clients and cash transfers."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="DalyData"
complexType="_XevB0TOqEeqX8uoQQ3KffQ" />
<messageBuildingBlock
xmi:id="_pq7TwUEXEeqXB_DgAcRqgw"
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="auth"
messageFunctionality="100"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.