camt.057.001.02
Scope The NotificationToReceive message is sent by an account owner or by a party acting on the account owner’s behalf to one of the account owner’s account servicing institutions. It is an advance notice that the account servicing institution will receive funds to be credited to the account of the account owner. Usage The NotificationToReceive message is used to advise the account servicing institution of funds that the account owner expects to have credited to its account. The message can be used in either a direct or a relay scenario.
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 %% NotificationToReceiveV02 recursion level 0 with max 0 NotificationToReceiveV02 *-- "1..1" GroupHeader43 : GroupHeader NotificationToReceiveV02 *-- "1..1" AccountNotification4 : Notification
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 %% GroupHeader43 recursion level 0 with max 1 class GroupHeader43{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader43 *-- "0..1" IParty7Choice : MessageSender %% IParty7Choice recursion level 1 with max 1
GroupHeader43 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageIdentification | Point to point reference, as assigned by the account owner or the party authorised to send the message, and sent to the account servicing institution, to unambiguously identify the message. | Usage: The sender has to make sure that ‘MessageIdentification’ is unique per account servicing institution for a pre-agreed period. |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
MessageSender | Identification of the party that is sending the message, when different from the account owner. | IParty7Choice - Optional 0..1 |
Notification building block
Set of elements used to provide further details on the account notification. Provides details on the account notification. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AccountNotification4 recursion level 0 with max 1 class AccountNotification4{ Identification IsoMax35Text TotalAmount IsoActiveOrHistoricCurrencyAndAmount ExpectedValueDate IsoISODate } AccountNotification4 *-- "0..1" CashAccount16 : Account AccountNotification4 *-- "0..1" IParty12Choice : AccountOwner AccountNotification4 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer AccountNotification4 *-- "0..1" CashAccount16 : RelatedAccount AccountNotification4 *-- "0..1" IParty12Choice : Debtor AccountNotification4 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent AccountNotification4 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent AccountNotification4 *-- "1..0" NotificationItem3 : Item %% CashAccount16 recursion level 1 with max 1 class CashAccount16{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount16 *-- "0..1" CashAccountType2 : Type %% IParty12Choice recursion level 1 with max 1 %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% CashAccount16 recursion level 1 with max 1 class CashAccount16{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount16 *-- "0..1" CashAccountType2 : Type %% IParty12Choice recursion level 1 with max 1 %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% NotificationItem3 recursion level 1 with max 1 class NotificationItem3{ Identification IsoMax35Text EndToEndIdentification IsoMax35Text Amount IsoActiveOrHistoricCurrencyAndAmount ExpectedValueDate IsoISODate } NotificationItem3 *-- "0..1" CashAccount16 : Account NotificationItem3 *-- "0..1" IParty12Choice : AccountOwner NotificationItem3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer NotificationItem3 *-- "0..1" CashAccount16 : RelatedAccount NotificationItem3 *-- "0..1" IParty12Choice : Debtor NotificationItem3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent NotificationItem3 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent NotificationItem3 *-- "0..1" IPurpose2Choice : Purpose NotificationItem3 *-- "0..1" RemittanceLocation2 : RelatedRemittanceInformation NotificationItem3 *-- "0..1" RemittanceInformation6 : RemittanceInformation
AccountNotification4 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Unique identification, as assigned by the account owner, to unambiguously identify the account notification. | IsoMax35Text - Required 1..1 |
Account | Identifies the account to be credited with the incoming amount of money. | CashAccount16 - Optional 0..1 |
AccountOwner | Party that legally owns the account. | IParty12Choice - Optional 0..1 |
AccountServicer | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
RelatedAccount | Identifies the parent account of the account to be credited with the incoming amount of money. | CashAccount16 - Optional 0..1 |
TotalAmount | Sum of the amounts in all the Item entries. | IsoActiveOrHistoricCurrencyAndAmount - Optional 0..1 |
ExpectedValueDate | Date on which the first agent expects the cash to be available to the final agent. | IsoISODate - Optional 0..1 |
Debtor | Party that owes an amount of money to the (ultimate) creditor. | IParty12Choice - Optional 0..1 |
DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
IntermediaryAgent | Agent between the debtor’s agent and the creditor’s agent. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
Item | Provides details of the expected amount on the account serviced by the account servicer. | NotificationItem3 - Unknown 1..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the NotificationToReceiveV02 implementation follows a specific implementaiton pattern. First of all, NotificationToReceiveV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NotificationToReceiveV02Document implements IOuterDocument. Because NotificationToReceiveV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NotificationToReceiveV02.
classDiagram class IOuterRecord NotificationToReceiveV02 --|> IOuterRecord : Implements NotificationToReceiveV02Document --|> IOuterDocument~NotificationToReceiveV02~ : Implements class IOuterDocument~NotificationToReceiveV02~ { NotificationToReceiveV02 Message }
Document wrapper for serialization
The only real purpose NotificationToReceiveV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.057.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using NotificationToReceiveV02.ToDocument() method. The returned NotificationToReceiveV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram NotificationToReceiveV02Document *-- NotificationToReceiveV02 : 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.057.001.02">
<NtfctnToRcv>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Ntfctn>
<!-- Notification inner content -->
</Ntfctn>
</NtfctnToRcv>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_sYylOmtdEeCY4-KZ9JEyUQ_-1019649132"
nextVersions="_sQvBQFkyEeGeoaLUQk__nA_-1087554980"
name="NotificationToReceiveV02"
definition="Scope
The NotificationToReceive message is sent by an account owner or by a party acting on the account owner's behalf to one of the account owner's account servicing institutions. It is an advance notice that the account servicing institution will receive funds to be credited to the account of the account owner.
Usage
The NotificationToReceive message is used to advise the account servicing institution of funds that the account owner expects to have credited to its account. The message can be used in either a direct or a relay scenario."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="NtfctnToRcv"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_sYylO2tdEeCY4-KZ9JEyUQ_-1623737271"
name="GroupHeader"
definition="Set of elements used to provide further details on the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_P9WSoNp-Ed-ak6NoX_4Aeg_1664465107" />
<messageBuildingBlock
xmi:id="_sY8WMGtdEeCY4-KZ9JEyUQ_1787996738"
name="Notification"
definition="Set of elements used to provide further details on the account notification."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Ntfctn"
complexType="_Gr9k4BGeEd-Obe88IjNoEg" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="057"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.