camt.054.001.02
Scope The BankToCustomerDebitCreditNotification message is sent by the account servicer to an account owner or to a party authorised by the account owner to receive the message. It can be used to inform the account owner, or authorised party, of single or multiple debit and/or credit entries reported to the account. Usage The BankToCustomerDebitCreditNotification message can contain reports for more than one account. It provides information for cash management and/or reconciliation. It can be used to:
- report pending and booked items;
- notify one or more debit entries;
- notify one or more credit entries;
- notify a combination of debit and credit entries. It can include underlying details of transactions that have been included in the entry. It is possible that the receiver of the message is not the account owner, but a party entitled by the account owner to receive the account information (also known as recipient). It does not contain balance information.
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 %% BankToCustomerDebitCreditNotificationV02 recursion level 0 with max 0 BankToCustomerDebitCreditNotificationV02 *-- "1..1" GroupHeader42 : GroupHeader BankToCustomerDebitCreditNotificationV02 *-- "1..1" AccountNotification2 : Notification
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Common information for the message. Set of elements used to provide further details of the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% GroupHeader42 recursion level 0 with max 1 class GroupHeader42{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime AdditionalInformation IsoMax500Text } GroupHeader42 *-- "0..1" PartyIdentification32 : MessageRecipient GroupHeader42 *-- "0..1" Pagination : MessagePagination %% PartyIdentification32 recursion level 1 with max 1 class PartyIdentification32{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification32 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification32 *-- "0..1" IParty6Choice : Identification PartyIdentification32 *-- "0..1" ContactDetails2 : ContactDetails %% Pagination recursion level 1 with max 1 class Pagination{ PageNumber IsoMax5NumericText LastPageIndicator IsoYesNoIndicator }
GroupHeader42 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. | Usage: The account servicing institution has to make sure that MessageIdentification is unique per account owner for a pre-agreed period. |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
MessageRecipient | Party authorised by the account owner to receive information about movements on the account. | Usage: MessageRecipient should only be identified when different from the account owner. |
MessagePagination | Set of elements used to provide details on the page number of the message. | |
AdditionalInformation | Further details of the message. | IsoMax500Text - Optional 0..1 |
Notification building block
Notifies debit and credit entries for the account. Set of elements used to provide details of the account notification. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AccountNotification2 recursion level 0 with max 1 class AccountNotification2{ Identification IsoMax35Text ElectronicSequenceNumber IsoNumber LegalSequenceNumber IsoNumber CreationDateTime IsoISODateTime CopyDuplicateIndicator CopyDuplicate1Code AdditionalNotificationInformation IsoMax500Text } AccountNotification2 *-- "0..1" DateTimePeriodDetails : FromToDate AccountNotification2 *-- "0..1" IReportingSource1Choice : ReportingSource AccountNotification2 *-- "1..1" CashAccount20 : Account AccountNotification2 *-- "0..1" CashAccount16 : RelatedAccount AccountNotification2 *-- "0..0" AccountInterest2 : Interest AccountNotification2 *-- "0..1" TotalTransactions2 : TransactionsSummary AccountNotification2 *-- "0..0" ReportEntry2 : Entry %% DateTimePeriodDetails recursion level 1 with max 1 class DateTimePeriodDetails{ FromDateTime IsoISODateTime ToDateTime IsoISODateTime } %% IReportingSource1Choice recursion level 1 with max 1 %% CashAccount20 recursion level 1 with max 1 class CashAccount20{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount20 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount20 *-- "0..1" CashAccountType2 : Type CashAccount20 *-- "0..1" PartyIdentification32 : Owner CashAccount20 *-- "0..1" BranchAndFinancialInstitutionIdentification4 : Servicer %% CashAccount16 recursion level 1 with max 1 class CashAccount16{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount16 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount16 *-- "0..1" CashAccountType2 : Type %% AccountInterest2 recursion level 1 with max 1 class AccountInterest2{ Reason IsoMax35Text } AccountInterest2 *-- "0..1" IInterestType1Choice : Type AccountInterest2 *-- "0..0" Rate3 : Rate AccountInterest2 *-- "0..1" DateTimePeriodDetails : FromToDate %% TotalTransactions2 recursion level 1 with max 1 TotalTransactions2 *-- "0..1" NumberAndSumOfTransactions2 : TotalEntries TotalTransactions2 *-- "0..1" NumberAndSumOfTransactions1 : TotalCreditEntries TotalTransactions2 *-- "0..1" NumberAndSumOfTransactions1 : TotalDebitEntries TotalTransactions2 *-- "0..0" TotalsPerBankTransactionCode2 : TotalEntriesPerBankTransactionCode %% ReportEntry2 recursion level 1 with max 1 class ReportEntry2{ EntryReference IsoMax35Text Amount IsoActiveOrHistoricCurrencyAndAmount CreditDebitIndicator CreditDebitCode ReversalIndicator IsoTrueFalseIndicator Status EntryStatus2Code AccountServicerReference IsoMax35Text CommissionWaiverIndicator IsoYesNoIndicator AdditionalEntryInformation IsoMax500Text } ReportEntry2 *-- "0..1" IDateAndDateTimeChoice : BookingDate ReportEntry2 *-- "0..1" IDateAndDateTimeChoice : ValueDate ReportEntry2 *-- "0..0" CashBalanceAvailability2 : Availability ReportEntry2 *-- "1..1" BankTransactionCodeStructure4 : BankTransactionCode ReportEntry2 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator ReportEntry2 *-- "0..1" AmountAndCurrencyExchange3 : AmountDetails ReportEntry2 *-- "0..0" ChargesInformation6 : Charges ReportEntry2 *-- "0..1" ITechnicalInputChannel1Choice : TechnicalInputChannel ReportEntry2 *-- "0..0" TransactionInterest2 : Interest ReportEntry2 *-- "0..0" EntryDetails1 : EntryDetails
AccountNotification2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Unique identification, as assigned by the account servicer, to unambiguously identify the account notification. | IsoMax35Text - Required 1..1 |
ElectronicSequenceNumber | Sequential number of the notification, as assigned by the account servicer. | Usage: The sequential number is increased incrementally for each notification sent electronically. |
LegalSequenceNumber | Legal sequential number of the notification, as assigned by the account servicer. It is increased incrementally for each notification sent. | IsoNumber - Optional 0..1 |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
FromToDate | Range of time between a start date and an end date for which the account notification is issued. | DateTimePeriodDetails - Optional 0..1 |
CopyDuplicateIndicator | Indicates whether the document is a copy, a duplicate, or a duplicate of a copy. | CopyDuplicate1Code - Optional 0..1 |
ReportingSource | Specifies the application used to generate the reporting. | IReportingSource1Choice - Optional 0..1 |
Account | Unambiguous identification of the account to which credit and debit entries are made. | CashAccount20 - Required 1..1 |
RelatedAccount | Identifies the parent account of the account for which the notification has been issued. | CashAccount16 - Optional 0..1 |
Interest | Set of elements used to provide general interest information that applies to the account at a particular moment in time. | AccountInterest2 - Unknown 0..0 |
TransactionsSummary | Set of elements used to provide summary information on entries. | TotalTransactions2 - Optional 0..1 |
Entry | Set of elements used to specify an entry in the debit credit notification. | Usage: At least one reference must be provided to identify the entry and its underlying transaction(s). |
AdditionalNotificationInformation | Further details of the account notification. | IsoMax500Text - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the BankToCustomerDebitCreditNotificationV02 implementation follows a specific implementaiton pattern. First of all, BankToCustomerDebitCreditNotificationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BankToCustomerDebitCreditNotificationV02Document implements IOuterDocument. Because BankToCustomerDebitCreditNotificationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BankToCustomerDebitCreditNotificationV02.
classDiagram class IOuterRecord BankToCustomerDebitCreditNotificationV02 --|> IOuterRecord : Implements BankToCustomerDebitCreditNotificationV02Document --|> IOuterDocument~BankToCustomerDebitCreditNotificationV02~ : Implements class IOuterDocument~BankToCustomerDebitCreditNotificationV02~ { BankToCustomerDebitCreditNotificationV02 Message }
Document wrapper for serialization
The only real purpose BankToCustomerDebitCreditNotificationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.054.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BankToCustomerDebitCreditNotificationV02.ToDocument() method. The returned BankToCustomerDebitCreditNotificationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram BankToCustomerDebitCreditNotificationV02Document *-- BankToCustomerDebitCreditNotificationV02 : 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.054.001.02">
<BkToCstmrDbtCdtNtfctn>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Ntfctn>
<!-- Notification inner content -->
</Ntfctn>
</BkToCstmrDbtCdtNtfctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_JG4lINE-Ed-BzquC8wXy7w_1022273973"
nextVersions="_r9gjQFkyEeGeoaLUQk__nA_376990161"
previousVersion="_In48CNE-Ed-BzquC8wXy7w_1638002708"
name="BankToCustomerDebitCreditNotificationV02"
definition="Scope
The BankToCustomerDebitCreditNotification message is sent by the account servicer to an account owner or to a party authorised by the account owner to receive the message. It can be used to inform the account owner, or authorised party, of single or multiple debit and/or credit entries reported to the account.
Usage
The BankToCustomerDebitCreditNotification message can contain reports for more than one account. It provides information for cash management and/or reconciliation.
It can be used to:
- report pending and booked items;
- notify one or more debit entries;
- notify one or more credit entries;
- notify a combination of debit and credit entries.
It can include underlying details of transactions that have been included in the entry.
It is possible that the receiver of the message is not the account owner, but a party entitled by the account owner to receive the account information (also known as recipient).
It does not contain balance information."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="BkToCstmrDbtCdtNtfctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_JG4lIdE-Ed-BzquC8wXy7w_1022274066"
name="GroupHeader"
definition="Common information for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_P31ggtp-Ed-ak6NoX_4Aeg_-1617619263" />
<messageBuildingBlock
xmi:id="_JG4lItE-Ed-BzquC8wXy7w_1022274014"
name="Notification"
definition="Notifies debit and credit entries for the account."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Ntfctn"
complexType="_Rqbfg9p-Ed-ak6NoX_4Aeg_-505997645" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="054"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.