camt.059.001.03
Scope The NotificationToReceiveStatusReport message is sent by an account servicing institution to an account owner or to a party acting on the account owner’s behalf. It is used to notify the account owner about the status of one or more expected payments that were advised in a previous NotificationToReceive message. Usage The NotificationToReceiveStatusReport message is sent in response to a NotificationToReceive message and can be used in either a direct or a relay scenario. It is used to advise the account owner of receipt of the funds as expected. It is also used to notify the account owner of non-receipt of funds or of discrepancies in the funds received.
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
%% NotificationToReceiveStatusReportV03 recursion level 0 with max 0
NotificationToReceiveStatusReportV03 *-- "1..1" GroupHeader60 : GroupHeader
NotificationToReceiveStatusReportV03 *-- "1..1" OriginalNotification5 : OriginalNotificationAndStatus
NotificationToReceiveStatusReportV03 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of elements used to provide further details on the message. Provides further details on the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader60 recursion level 0 with max 1
class GroupHeader60{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader60 *-- "0..1" IParty12Choice : MessageRecipient
%% IParty12Choice recursion level 1 with max 1
GroupHeader60 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the account servicing institution, and sent to the account owner or the party authorised to receive the message, to unambiguously identify the message. | |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| MessageRecipient | Identification of the party that is receiving the message, when different from the account owner. | IParty12Choice - Optional 0..1 |
OriginalNotificationAndStatus building block
Set of elements used to identify the original notification and to provide the status. Identifies the original notification and to provide the status. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% OriginalNotification5 recursion level 0 with max 1
class OriginalNotification5{
OriginalMessageIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
OriginalNotificationIdentification IsoMax35Text
NotificationStatus NotificationStatus3Code
AdditionalStatusInformation IsoMax140Text
}
OriginalNotification5 *-- "0..0" OriginalNotificationReference3 : OriginalNotificationReference
%% OriginalNotificationReference3 recursion level 1 with max 1
class OriginalNotificationReference3{
TotalAmount IsoActiveOrHistoricCurrencyAndAmount
ExpectedValueDate IsoISODate
}
OriginalNotificationReference3 *-- "0..1" CashAccount24 : Account
OriginalNotificationReference3 *-- "0..1" IParty12Choice : AccountOwner
OriginalNotificationReference3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer
OriginalNotificationReference3 *-- "0..1" CashAccount24 : RelatedAccount
OriginalNotificationReference3 *-- "0..1" IParty12Choice : Debtor
OriginalNotificationReference3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent
OriginalNotificationReference3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent
OriginalNotificationReference3 *-- "1..0" OriginalItemAndStatus3 : OriginalItemAndStatus
OriginalNotification5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalMessageIdentification | Point to point reference, as assigned by the original sender, to unambiguously identify the original notification to receive message. | IsoMax35Text - Required 1..1 |
| OriginalCreationDateTime | Date and time at which the original message was created. | IsoISODateTime - Optional 0..1 |
| OriginalNotificationIdentification | Identification of the original notification. | IsoMax35Text - Required 1..1 |
| NotificationStatus | Specifies the status of the notification in a coded form. | NotificationStatus3Code - Optional 0..1 |
| AdditionalStatusInformation | Further details of the notification status. | IsoMax140Text - Optional 0..1 |
| OriginalNotificationReference | Identifies the original notification item and provides the status. | OriginalNotificationReference3 - Unknown 0..0 |
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 NotificationToReceiveStatusReportV03 implementation follows a specific implementaiton pattern. First of all, NotificationToReceiveStatusReportV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NotificationToReceiveStatusReportV03Document implements IOuterDocument. Because NotificationToReceiveStatusReportV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NotificationToReceiveStatusReportV03.
classDiagram
class IOuterRecord
NotificationToReceiveStatusReportV03 --|> IOuterRecord : Implements
NotificationToReceiveStatusReportV03Document --|> IOuterDocument~NotificationToReceiveStatusReportV03~ : Implements
class IOuterDocument~NotificationToReceiveStatusReportV03~ {
NotificationToReceiveStatusReportV03 Message
}
Document wrapper for serialization
The only real purpose NotificationToReceiveStatusReportV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.059.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using NotificationToReceiveStatusReportV03.ToDocument() method. The returned NotificationToReceiveStatusReportV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
NotificationToReceiveStatusReportV03Document *-- NotificationToReceiveStatusReportV03 : 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:camt.059.001.03">
<NtfctnToRcvStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlNtfctnAndSts>
<!-- OriginalNotificationAndStatus inner content -->
</OrgnlNtfctnAndSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</NtfctnToRcvStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_sRLtMFkyEeGeoaLUQk__nA_-2102986069"
nextVersions="_VJ9wCRPeEeSVo-TFVwFHvA"
previousVersion="_sZFgJWtdEeCY4-KZ9JEyUQ_-1390141251"
name="NotificationToReceiveStatusReportV03"
definition="Scope
The NotificationToReceiveStatusReport message is sent by an account servicing institution to an account owner or to a party acting on the account owner's behalf. It is used to notify the account owner about the status of one or more expected payments that were advised in a previous NotificationToReceive message.
Usage
The NotificationToReceiveStatusReport message is sent in response to a NotificationToReceive message and can be used in either a direct or a relay scenario. It is used to advise the account owner of receipt of the funds as expected. It is also used to notify the account owner of non-receipt of funds or of discrepancies in the funds received."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="NtfctnToRcvStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_sRLtMVkyEeGeoaLUQk__nA_-1965847017"
nextVersions="_VJ9wCxPeEeSVo-TFVwFHvA"
name="GroupHeader"
definition="Set of elements used to provide further details on the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_s-opElkyEeGeoaLUQk__nA_-409691962" />
<messageBuildingBlock
xmi:id="_sRLtMlkyEeGeoaLUQk__nA_1332047926"
nextVersions="_VJ9wDRPeEeSVo-TFVwFHvA"
name="OriginalNotificationAndStatus"
definition="Set of elements used to identify the original notification and to provide the status."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="OrgnlNtfctnAndSts"
complexType="_sg1SwlkyEeGeoaLUQk__nA_-453347482" />
<messageBuildingBlock
xmi:id="_sRLtM1kyEeGeoaLUQk__nA_-515949434"
nextVersions="_VJ9wDxPeEeSVo-TFVwFHvA"
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="camt"
messageFunctionality="059"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.