camt.054.001.01
Scope The Bank-to-Customer Debit/Credit Notification 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 Bank-to-Customer Debit/Credit Notification message can contain reports for more than 1 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 %% BankToCustomerDebitCreditNotificationV01 recursion level 0 with max 0 BankToCustomerDebitCreditNotificationV01 *-- "1..1" GroupHeader23 : GroupHeader BankToCustomerDebitCreditNotificationV01 *-- "1..1" AccountNotification1 : 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 providing further details on the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% GroupHeader23 recursion level 0 with max 1 class GroupHeader23{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime AdditionalInformation IsoMax500Text } GroupHeader23 *-- "0..1" PartyIdentification8 : MessageRecipient GroupHeader23 *-- "0..1" Pagination : MessagePagination %% PartyIdentification8 recursion level 1 with max 1 class PartyIdentification8{ Name IsoMax70Text CountryOfResidence CountryCode } PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress PartyIdentification8 *-- "0..1" IParty2Choice : Identification %% Pagination recursion level 1 with max 1 class Pagination{ PageNumber IsoMax5NumericText LastPageIndicator IsoYesNoIndicator }
GroupHeader23 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageIdentification | Point to point reference assigned by the account servicing institution and sent to the account owner to unambiguously identify the message. | |
CreationDateTime | Date and time at which the message was created by the account servicer. | IsoISODateTime - Required 1..1 |
MessageRecipient | Party that is entitled by the account owner to receive information about movements in the account. | |
MessagePagination | Pagination of the message. | |
AdditionalInformation | Further details on the message. | IsoMax500Text - Optional 0..1 |
Notification building block
Notifies debit and credit entries for the account. Set of elements providing further details on the account notification. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AccountNotification1 recursion level 0 with max 1 class AccountNotification1{ Identification IsoMax35Text ElectronicSequenceNumber IsoNumber LegalSequenceNumber IsoNumber CreationDateTime IsoISODateTime CopyDuplicateIndicator CopyDuplicate1Code AdditionalNotificationInformation IsoMax500Text } AccountNotification1 *-- "0..1" DateTimePeriodDetails : FromToDate AccountNotification1 *-- "1..1" CashAccount13 : Account AccountNotification1 *-- "0..1" CashAccount7 : RelatedAccount AccountNotification1 *-- "0..1" TotalTransactions1 : TransactionsSummary AccountNotification1 *-- "0..0" NotificationEntry1 : Entry %% DateTimePeriodDetails recursion level 1 with max 1 class DateTimePeriodDetails{ FromDateTime IsoISODateTime ToDateTime IsoISODateTime } %% CashAccount13 recursion level 1 with max 1 class CashAccount13{ Currency CurrencyCode Name IsoMax70Text } CashAccount13 *-- "1..1" IAccountIdentification3Choice : Identification CashAccount13 *-- "0..1" CashAccountType2 : Type CashAccount13 *-- "0..1" PartyIdentification8 : Owner CashAccount13 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : Servicer %% CashAccount7 recursion level 1 with max 1 class CashAccount7{ Currency CurrencyCode Name IsoMax70Text } CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification CashAccount7 *-- "0..1" CashAccountType2 : Type %% TotalTransactions1 recursion level 1 with max 1 TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions2 : TotalEntries TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions1 : TotalCreditEntries TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions1 : TotalDebitEntries TotalTransactions1 *-- "0..0" NumberAndSumOfTransactionsPerBankTransactionCode1 : TotalEntriesPerBankTransactionCode %% NotificationEntry1 recursion level 1 with max 1 class NotificationEntry1{ Amount IsoCurrencyAndAmount CreditDebitIndicator CreditDebitCode ReversalIndicator IsoTrueFalseIndicator Status EntryStatus4Code AccountServicerReference IsoMax35Text CommissionWaiverIndicator IsoYesNoIndicator AdditionalEntryInformation IsoMax500Text } NotificationEntry1 *-- "0..1" IDateAndDateTimeChoice : BookingDate NotificationEntry1 *-- "0..1" IDateAndDateTimeChoice : ValueDate NotificationEntry1 *-- "0..0" CashBalanceAvailability1 : Availability NotificationEntry1 *-- "1..1" BankTransactionCodeStructure1 : BankTransactionCode NotificationEntry1 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator NotificationEntry1 *-- "0..0" BatchInformation1 : Batch NotificationEntry1 *-- "0..1" AmountAndCurrencyExchange2 : AmountDetails NotificationEntry1 *-- "0..0" ChargesInformation3 : Charges NotificationEntry1 *-- "0..0" TransactionInterest1 : Interest NotificationEntry1 *-- "0..0" EntryTransaction1 : TransactionDetails
AccountNotification1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Unique and unambiguous identification of the account report, assigned by the account servicer. | IsoMax35Text - Required 1..1 |
ElectronicSequenceNumber | Sequential number of the report, assigned by the account servicer. It is increased incrementally for each report sent electronically. | IsoNumber - Optional 0..1 |
LegalSequenceNumber | Legal sequential number of the report, assigned by the account servicer. It is increased incrementally for each report sent. | |
CreationDateTime | Date and time at which the report was created. | IsoISODateTime - Required 1..1 |
FromToDate | Range of time between the start date and the end date for which the account notification is issued. | DateTimePeriodDetails - Optional 0..1 |
CopyDuplicateIndicator | Specifies if this document is a copy, a duplicate, or a duplicate of a copy. | CopyDuplicate1Code - Optional 0..1 |
Account | Business relationship between two entities; one entity is the account owner, the other entity is the account servicer. | CashAccount13 - Required 1..1 |
RelatedAccount | Identifies the parent account of the reported account. | CashAccount7 - Optional 0..1 |
TransactionsSummary | Set of element providing summary information on entries. | TotalTransactions1 - Optional 0..1 |
Entry | Specifies the elements of an entry in the report. | |
AdditionalNotificationInformation | Further details on the account notification. | IsoMax500Text - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the BankToCustomerDebitCreditNotificationV01 implementation follows a specific implementaiton pattern. First of all, BankToCustomerDebitCreditNotificationV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BankToCustomerDebitCreditNotificationV01Document implements IOuterDocument. Because BankToCustomerDebitCreditNotificationV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BankToCustomerDebitCreditNotificationV01.
classDiagram class IOuterRecord BankToCustomerDebitCreditNotificationV01 --|> IOuterRecord : Implements BankToCustomerDebitCreditNotificationV01Document --|> IOuterDocument~BankToCustomerDebitCreditNotificationV01~ : Implements class IOuterDocument~BankToCustomerDebitCreditNotificationV01~ { BankToCustomerDebitCreditNotificationV01 Message }
Document wrapper for serialization
The only real purpose BankToCustomerDebitCreditNotificationV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.054.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BankToCustomerDebitCreditNotificationV01.ToDocument() method. The returned BankToCustomerDebitCreditNotificationV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram BankToCustomerDebitCreditNotificationV01Document *-- BankToCustomerDebitCreditNotificationV01 : 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.01">
<BkToCstmrDbtCdtNtfctnV01>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Ntfctn>
<!-- Notification inner content -->
</Ntfctn>
</BkToCstmrDbtCdtNtfctnV01>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_In48CNE-Ed-BzquC8wXy7w_1638002708"
nextVersions="_JG4lINE-Ed-BzquC8wXy7w_1022273973"
name="BankToCustomerDebitCreditNotificationV01"
definition="Scope
The Bank-to-Customer Debit/Credit Notification 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 Bank-to-Customer Debit/Credit Notification message can contain reports for more than 1 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="BkToCstmrDbtCdtNtfctnV01"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_In48CdE-Ed-BzquC8wXy7w_640607521"
name="GroupHeader"
definition="Common information for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_PynpV9p-Ed-ak6NoX_4Aeg_-1593387431" />
<messageBuildingBlock
xmi:id="_IoCF8NE-Ed-BzquC8wXy7w_296135544"
name="Notification"
definition="Notifies debit and credit entries for the account."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Ntfctn"
complexType="_RTe_JNp-Ed-ak6NoX_4Aeg_-1487171908" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="054"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.