camt.057.001.04
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 %% NotificationToReceiveV04 recursion level 0 with max 0 NotificationToReceiveV04 *-- "1..1" GroupHeader59 : GroupHeader NotificationToReceiveV04 *-- "1..1" AccountNotification10 : Notification NotificationToReceiveV04 *-- "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 %% GroupHeader59 recursion level 0 with max 1 class GroupHeader59{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader59 *-- "0..1" IParty12Choice : MessageSender %% IParty12Choice recursion level 1 with max 1
GroupHeader59 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. | IParty12Choice - 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 %% AccountNotification10 recursion level 0 with max 1 class AccountNotification10{ Identification IsoMax35Text TotalAmount IsoActiveOrHistoricCurrencyAndAmount ExpectedValueDate IsoISODate } AccountNotification10 *-- "0..1" CashAccount24 : Account AccountNotification10 *-- "0..1" IParty12Choice : AccountOwner AccountNotification10 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer AccountNotification10 *-- "0..1" CashAccount24 : RelatedAccount AccountNotification10 *-- "0..1" IParty12Choice : Debtor AccountNotification10 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent AccountNotification10 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent AccountNotification10 *-- "1..0" NotificationItem5 : Item %% CashAccount24 recursion level 1 with max 1 class CashAccount24{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount24 *-- "0..1" ICashAccountType2Choice : 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 %% CashAccount24 recursion level 1 with max 1 class CashAccount24{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount24 *-- "0..1" ICashAccountType2Choice : 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 %% NotificationItem5 recursion level 1 with max 1 class NotificationItem5{ Identification IsoMax35Text EndToEndIdentification IsoMax35Text Amount IsoActiveOrHistoricCurrencyAndAmount ExpectedValueDate IsoISODate } NotificationItem5 *-- "0..1" CashAccount24 : Account NotificationItem5 *-- "0..1" IParty12Choice : AccountOwner NotificationItem5 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer NotificationItem5 *-- "0..1" CashAccount24 : RelatedAccount NotificationItem5 *-- "0..1" IParty12Choice : Debtor NotificationItem5 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent NotificationItem5 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : IntermediaryAgent NotificationItem5 *-- "0..1" IPurpose2Choice : Purpose NotificationItem5 *-- "0..1" RemittanceLocation4 : RelatedRemittanceInformation NotificationItem5 *-- "0..1" RemittanceInformation10 : RemittanceInformation
AccountNotification10 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. | CashAccount24 - 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. | CashAccount24 - 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. | NotificationItem5 - Unknown 1..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 NotificationToReceiveV04 implementation follows a specific implementaiton pattern. First of all, NotificationToReceiveV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NotificationToReceiveV04Document implements IOuterDocument. Because NotificationToReceiveV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NotificationToReceiveV04.
classDiagram class IOuterRecord NotificationToReceiveV04 --|> IOuterRecord : Implements NotificationToReceiveV04Document --|> IOuterDocument~NotificationToReceiveV04~ : Implements class IOuterDocument~NotificationToReceiveV04~ { NotificationToReceiveV04 Message }
Document wrapper for serialization
The only real purpose NotificationToReceiveV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.057.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using NotificationToReceiveV04.ToDocument() method. The returned NotificationToReceiveV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram NotificationToReceiveV04Document *-- NotificationToReceiveV04 : 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.04">
<NtfctnToRcv>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Ntfctn>
<!-- Notification inner content -->
</Ntfctn>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</NtfctnToRcv>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_VJ9wERPeEeSVo-TFVwFHvA"
nextVersions="_pmmdgTqxEeWZFYSPlduMhw"
previousVersion="_sQvBQFkyEeGeoaLUQk__nA_-1087554980"
name="NotificationToReceiveV04"
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="_VJ9wExPeEeSVo-TFVwFHvA"
nextVersions="_pmmdgzqxEeWZFYSPlduMhw"
previousVersion="_sQvBQVkyEeGeoaLUQk__nA_-985905690"
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-e4EVkyEeGeoaLUQk__nA_754761691" />
<messageBuildingBlock
xmi:id="_VJ9wFRPeEeSVo-TFVwFHvA"
nextVersions="_pmmdhTqxEeWZFYSPlduMhw"
previousVersion="_sQ4yQFkyEeGeoaLUQk__nA_-1982978043"
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="_atcx-x77EeSxevWRRWxNAg" />
<messageBuildingBlock
xmi:id="_VJ9wFxPeEeSVo-TFVwFHvA"
nextVersions="_pmmdhzqxEeWZFYSPlduMhw"
previousVersion="_sQ4yQVkyEeGeoaLUQk__nA_-769326936"
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="057"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.