camt.054.001.03
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
%% BankToCustomerDebitCreditNotificationV03 recursion level 0 with max 0
BankToCustomerDebitCreditNotificationV03 *-- "1..1" GroupHeader58 : GroupHeader
BankToCustomerDebitCreditNotificationV03 *-- "1..1" AccountNotification5 : Notification
BankToCustomerDebitCreditNotificationV03 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Common information for the message. Provides further details on the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader58 recursion level 0 with max 1
class GroupHeader58{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
AdditionalInformation IsoMax500Text
}
GroupHeader58 *-- "0..1" PartyIdentification43 : MessageRecipient
GroupHeader58 *-- "0..1" Pagination : MessagePagination
GroupHeader58 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% Pagination recursion level 1 with max 1
class Pagination{
PageNumber IsoMax5NumericText
LastPageIndicator IsoYesNoIndicator
}
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader58 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 | Provides details on the page number of the message. | |
| OriginalBusinessQuery | Unique identification, as assigned by the original requestor, to unambiguously identify the business query message. | OriginalBusinessQuery1 - Optional 0..1 |
| AdditionalInformation | Further details of the message. | IsoMax500Text - Optional 0..1 |
Notification building block
Notifies debit and credit entries for the account. Provides further details of the account notification. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AccountNotification5 recursion level 0 with max 1
class AccountNotification5{
Identification IsoMax35Text
ElectronicSequenceNumber IsoNumber
LegalSequenceNumber IsoNumber
CreationDateTime IsoISODateTime
CopyDuplicateIndicator CopyDuplicate1Code
AdditionalNotificationInformation IsoMax500Text
}
AccountNotification5 *-- "0..1" Pagination : NotificationPagination
AccountNotification5 *-- "0..1" DateTimePeriodDetails : FromToDate
AccountNotification5 *-- "0..1" IReportingSource1Choice : ReportingSource
AccountNotification5 *-- "1..1" CashAccount25 : Account
AccountNotification5 *-- "0..1" CashAccount24 : RelatedAccount
AccountNotification5 *-- "0..0" AccountInterest2 : Interest
AccountNotification5 *-- "0..1" TotalTransactions2 : TransactionsSummary
AccountNotification5 *-- "0..0" ReportEntry3 : Entry
%% Pagination recursion level 1 with max 1
class Pagination{
PageNumber IsoMax5NumericText
LastPageIndicator IsoYesNoIndicator
}
%% DateTimePeriodDetails recursion level 1 with max 1
class DateTimePeriodDetails{
FromDateTime IsoISODateTime
ToDateTime IsoISODateTime
}
%% IReportingSource1Choice recursion level 1 with max 1
%% CashAccount25 recursion level 1 with max 1
class CashAccount25{
Currency ActiveOrHistoricCurrencyCode
Name IsoMax70Text
}
CashAccount25 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount25 *-- "0..1" ICashAccountType2Choice : Type
CashAccount25 *-- "0..1" PartyIdentification43 : Owner
CashAccount25 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : Servicer
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
Currency ActiveOrHistoricCurrencyCode
Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : 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
%% ReportEntry3 recursion level 1 with max 1
class ReportEntry3{
EntryReference IsoMax35Text
Amount IsoActiveOrHistoricCurrencyAndAmount
CreditDebitIndicator CreditDebitCode
ReversalIndicator IsoTrueFalseIndicator
Status EntryStatus2Code
AccountServicerReference IsoMax35Text
CommissionWaiverIndicator IsoYesNoIndicator
AdditionalEntryInformation IsoMax500Text
}
ReportEntry3 *-- "0..1" IDateAndDateTimeChoice : BookingDate
ReportEntry3 *-- "0..1" IDateAndDateTimeChoice : ValueDate
ReportEntry3 *-- "0..0" CashBalanceAvailability2 : Availability
ReportEntry3 *-- "1..1" BankTransactionCodeStructure4 : BankTransactionCode
ReportEntry3 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator
ReportEntry3 *-- "0..1" AmountAndCurrencyExchange3 : AmountDetails
ReportEntry3 *-- "0..0" Charges3 : Charges
ReportEntry3 *-- "0..1" ITechnicalInputChannel1Choice : TechnicalInputChannel
ReportEntry3 *-- "0..0" TransactionInterest3 : Interest
ReportEntry3 *-- "0..1" CardEntry1 : CardTransaction
ReportEntry3 *-- "0..0" EntryDetails2 : EntryDetails
AccountNotification5 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 |
| NotificationPagination | Provides details on the page number of the notification. Usage: The pagination of the notification is only allowed when agreed between the parties. | Pagination - Optional 0..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. | CashAccount25 - Required 1..1 |
| RelatedAccount | Identifies the parent account of the account for which the notification has been issued. | CashAccount24 - Optional 0..1 |
| Interest | Provides general interest information that applies to the account at a particular moment in time. | AccountInterest2 - Unknown 0..0 |
| TransactionsSummary | Provides 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 |
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 BankToCustomerDebitCreditNotificationV03 implementation follows a specific implementaiton pattern. First of all, BankToCustomerDebitCreditNotificationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BankToCustomerDebitCreditNotificationV03Document implements IOuterDocument. Because BankToCustomerDebitCreditNotificationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BankToCustomerDebitCreditNotificationV03.
classDiagram
class IOuterRecord
BankToCustomerDebitCreditNotificationV03 --|> IOuterRecord : Implements
BankToCustomerDebitCreditNotificationV03Document --|> IOuterDocument~BankToCustomerDebitCreditNotificationV03~ : Implements
class IOuterDocument~BankToCustomerDebitCreditNotificationV03~ {
BankToCustomerDebitCreditNotificationV03 Message
}
Document wrapper for serialization
The only real purpose BankToCustomerDebitCreditNotificationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.054.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BankToCustomerDebitCreditNotificationV03.ToDocument() method. The returned BankToCustomerDebitCreditNotificationV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
BankToCustomerDebitCreditNotificationV03Document *-- BankToCustomerDebitCreditNotificationV03 : 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.03">
<BkToCstmrDbtCdtNtfctn>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Ntfctn>
<!-- Notification inner content -->
</Ntfctn>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</BkToCstmrDbtCdtNtfctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_r9gjQFkyEeGeoaLUQk__nA_376990161"
nextVersions="_7yqioSGnEeKjd4jizyIDGA"
previousVersion="_JG4lINE-Ed-BzquC8wXy7w_1022273973"
name="BankToCustomerDebitCreditNotificationV03"
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">
<constraint
xmi:id="_r9qUQFkyEeGeoaLUQk__nA_230467539"
name="MessageOrNotificationPaginationRule"
definition="MessagePagination may be present or NotificationPagination may be present, but not both."
registrationStatus="Provisionally Registered"
expression="<RuleDefinition><SimpleRule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleRule"><mustBe><connector>OR</connector><BooleanRule xsi:type="Absence"><leftOperand>/GroupHeader/MessagePagination</leftOperand></BooleanRule><BooleanRule xsi:type="Absence"><leftOperand>/Notification[*]/NotificationPagination</leftOperand></BooleanRule></mustBe></SimpleRule></RuleDefinition>" />
<messageBuildingBlock
xmi:id="_r9gjQVkyEeGeoaLUQk__nA_663181991"
name="GroupHeader"
definition="Common information for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_s-L9JFkyEeGeoaLUQk__nA_460842520" />
<messageBuildingBlock
xmi:id="_r9gjQlkyEeGeoaLUQk__nA_-220051296"
name="Notification"
definition="Notifies debit and credit entries for the account."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Ntfctn"
complexType="_tryC8FkyEeGeoaLUQk__nA_-1904568694" />
<messageBuildingBlock
xmi:id="_LPuYU59YEeGBX4a4yy-WHg_-2001686644"
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="054"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.