camt.059.001.02
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 %% NotificationToReceiveStatusReportV02 recursion level 0 with max 0 NotificationToReceiveStatusReportV02 *-- "1..1" GroupHeader44 : GroupHeader NotificationToReceiveStatusReportV02 *-- "1..1" OriginalNotification3 : OriginalNotificationAndStatus
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. Set of elements used to provide further details on the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% GroupHeader44 recursion level 0 with max 1 class GroupHeader44{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader44 *-- "0..1" IParty7Choice : MessageRecipient %% IParty7Choice recursion level 1 with max 1
GroupHeader44 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. | IParty7Choice - Optional 0..1 |
OriginalNotificationAndStatus building block
Set of elements used to identify the original notification and to provide the status. Identify the original notification and to provide the status. For comparison, see the ISO20022 official specification
classDiagram direction tb %% OriginalNotification3 recursion level 0 with max 1 class OriginalNotification3{ OriginalMessageIdentification IsoMax35Text OriginalCreationDateTime IsoISODateTime OriginalNotificationIdentification IsoMax35Text NotificationStatus NotificationStatus3Code AdditionalStatusInformation IsoMax140Text } OriginalNotification3 *-- "0..0" OriginalNotificationReference2 : OriginalNotificationReference %% OriginalNotificationReference2 recursion level 1 with max 1 class OriginalNotificationReference2{ TotalAmount IsoActiveOrHistoricCurrencyAndAmount ExpectedValueDate IsoISODate } OriginalNotificationReference2 *-- "0..1" CashAccount16 : Account OriginalNotificationReference2 *-- "0..1" IParty12Choice : AccountOwner OriginalNotificationReference2 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer OriginalNotificationReference2 *-- "0..1" CashAccount16 : RelatedAccount OriginalNotificationReference2 *-- "0..1" IParty12Choice : Debtor OriginalNotificationReference2 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent OriginalNotificationReference2 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent OriginalNotificationReference2 *-- "1..0" OriginalItemAndStatus2 : OriginalItemAndStatus
OriginalNotification3 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. | OriginalNotificationReference2 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the NotificationToReceiveStatusReportV02 implementation follows a specific implementaiton pattern. First of all, NotificationToReceiveStatusReportV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NotificationToReceiveStatusReportV02Document implements IOuterDocument. Because NotificationToReceiveStatusReportV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NotificationToReceiveStatusReportV02.
classDiagram class IOuterRecord NotificationToReceiveStatusReportV02 --|> IOuterRecord : Implements NotificationToReceiveStatusReportV02Document --|> IOuterDocument~NotificationToReceiveStatusReportV02~ : Implements class IOuterDocument~NotificationToReceiveStatusReportV02~ { NotificationToReceiveStatusReportV02 Message }
Document wrapper for serialization
The only real purpose NotificationToReceiveStatusReportV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.059.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using NotificationToReceiveStatusReportV02.ToDocument() method. The returned NotificationToReceiveStatusReportV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram NotificationToReceiveStatusReportV02Document *-- NotificationToReceiveStatusReportV02 : 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.02">
<NtfctnToRcvStsRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<OrgnlNtfctnAndSts>
<!-- OriginalNotificationAndStatus inner content -->
</OrgnlNtfctnAndSts>
</NtfctnToRcvStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_sZFgJWtdEeCY4-KZ9JEyUQ_-1390141251"
nextVersions="_sRLtMFkyEeGeoaLUQk__nA_-2102986069"
name="NotificationToReceiveStatusReportV02"
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="_sZZCIGtdEeCY4-KZ9JEyUQ_1005512460"
name="GroupHeader"
definition="Set of elements used to provide further details on the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_P9gDotp-Ed-ak6NoX_4Aeg_1780446347" />
<messageBuildingBlock
xmi:id="_sZZCIWtdEeCY4-KZ9JEyUQ_122279173"
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="_1E2M0Bf2Ed--ta5221d4PQ" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="059"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.