camt.052.001.08
Scope The BankToCustomerAccountReport 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 the entries reported to the account, and/or to provide the owner with balance information on the account at a given point in time. Usage The BankToCustomerAccountReport 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;
- provide balance information. 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). For a statement, the Bank-to-Customer Account Statement message should be used.
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
%% BankToCustomerAccountReportV08 recursion level 0 with max 0
BankToCustomerAccountReportV08 *-- "1..1" GroupHeader81 : GroupHeader
BankToCustomerAccountReportV08 *-- "1..1" AccountReport25 : Report
BankToCustomerAccountReportV08 *-- "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
%% GroupHeader81 recursion level 0 with max 1
class GroupHeader81{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
AdditionalInformation IsoMax500Text
}
GroupHeader81 *-- "0..1" PartyIdentification135 : MessageRecipient
GroupHeader81 *-- "0..1" Pagination1 : MessagePagination
GroupHeader81 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% Pagination1 recursion level 1 with max 1
class Pagination1{
PageNumber IsoMax5NumericText
LastPageIndicator IsoYesNoIndicator
}
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader81 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 |
Report building block
Reports on a cash account. Provides further details of the account report. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AccountReport25 recursion level 0 with max 1
class AccountReport25{
Identification IsoMax35Text
ElectronicSequenceNumber IsoNumber
LegalSequenceNumber IsoNumber
CreationDateTime IsoISODateTime
CopyDuplicateIndicator CopyDuplicate1Code
AdditionalReportInformation IsoMax500Text
}
AccountReport25 *-- "0..1" Pagination1 : ReportPagination
AccountReport25 *-- "0..1" ISequenceRange1Choice : ReportingSequence
AccountReport25 *-- "0..1" DateTimePeriod1 : FromToDate
AccountReport25 *-- "0..1" IReportingSource1Choice : ReportingSource
AccountReport25 *-- "1..1" CashAccount39 : Account
AccountReport25 *-- "0..1" CashAccount38 : RelatedAccount
AccountReport25 *-- "0..0" AccountInterest4 : Interest
AccountReport25 *-- "0..0" CashBalance8 : Balance
AccountReport25 *-- "0..1" TotalTransactions6 : TransactionsSummary
AccountReport25 *-- "0..0" ReportEntry10 : Entry
%% Pagination1 recursion level 1 with max 1
class Pagination1{
PageNumber IsoMax5NumericText
LastPageIndicator IsoYesNoIndicator
}
%% ISequenceRange1Choice recursion level 1 with max 1
%% DateTimePeriod1 recursion level 1 with max 1
class DateTimePeriod1{
FromDateTime IsoISODateTime
ToDateTime IsoISODateTime
}
%% IReportingSource1Choice recursion level 1 with max 1
%% CashAccount39 recursion level 1 with max 1
class CashAccount39{
Currency ActiveOrHistoricCurrencyCode
Name IsoMax70Text
}
CashAccount39 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount39 *-- "0..1" ICashAccountType2Choice : Type
CashAccount39 *-- "0..1" ProxyAccountIdentification1 : Proxy
CashAccount39 *-- "0..1" PartyIdentification135 : Owner
CashAccount39 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : Servicer
%% CashAccount38 recursion level 1 with max 1
class CashAccount38{
Currency ActiveOrHistoricCurrencyCode
Name IsoMax70Text
}
CashAccount38 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount38 *-- "0..1" ICashAccountType2Choice : Type
CashAccount38 *-- "0..1" ProxyAccountIdentification1 : Proxy
%% AccountInterest4 recursion level 1 with max 1
class AccountInterest4{
Reason IsoMax35Text
}
AccountInterest4 *-- "0..1" IInterestType1Choice : Type
AccountInterest4 *-- "0..0" Rate4 : Rate
AccountInterest4 *-- "0..1" DateTimePeriod1 : FromToDate
AccountInterest4 *-- "0..1" TaxCharges2 : Tax
%% CashBalance8 recursion level 1 with max 1
class CashBalance8{
Amount IsoActiveOrHistoricCurrencyAndAmount
CreditDebitIndicator CreditDebitCode
}
CashBalance8 *-- "1..1" BalanceType13 : Type
CashBalance8 *-- "0..0" CreditLine3 : CreditLine
CashBalance8 *-- "1..1" IDateAndDateTime2Choice : Date
CashBalance8 *-- "0..0" CashAvailability1 : Availability
%% TotalTransactions6 recursion level 1 with max 1
TotalTransactions6 *-- "0..1" NumberAndSumOfTransactions4 : TotalEntries
TotalTransactions6 *-- "0..1" NumberAndSumOfTransactions1 : TotalCreditEntries
TotalTransactions6 *-- "0..1" NumberAndSumOfTransactions1 : TotalDebitEntries
TotalTransactions6 *-- "0..0" TotalsPerBankTransactionCode5 : TotalEntriesPerBankTransactionCode
%% ReportEntry10 recursion level 1 with max 1
class ReportEntry10{
EntryReference IsoMax35Text
Amount IsoActiveOrHistoricCurrencyAndAmount
CreditDebitIndicator CreditDebitCode
ReversalIndicator IsoTrueFalseIndicator
AccountServicerReference IsoMax35Text
CommissionWaiverIndicator IsoYesNoIndicator
AdditionalEntryInformation IsoMax500Text
}
ReportEntry10 *-- "1..1" IEntryStatus1Choice : Status
ReportEntry10 *-- "0..1" IDateAndDateTime2Choice : BookingDate
ReportEntry10 *-- "0..1" IDateAndDateTime2Choice : ValueDate
ReportEntry10 *-- "0..0" CashAvailability1 : Availability
ReportEntry10 *-- "1..1" BankTransactionCodeStructure4 : BankTransactionCode
ReportEntry10 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator
ReportEntry10 *-- "0..1" AmountAndCurrencyExchange3 : AmountDetails
ReportEntry10 *-- "0..1" Charges6 : Charges
ReportEntry10 *-- "0..1" ITechnicalInputChannel1Choice : TechnicalInputChannel
ReportEntry10 *-- "0..1" TransactionInterest4 : Interest
ReportEntry10 *-- "0..1" CardEntry4 : CardTransaction
ReportEntry10 *-- "0..0" EntryDetails9 : EntryDetails
AccountReport25 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Identification | Unique identification, as assigned by the account servicer, to unambiguously identify the account report. | IsoMax35Text - Required 1..1 |
| ReportPagination | Provides details on the page number of the report. Usage: The pagination of the report is only allowed when agreed between the parties. | Pagination1 - Optional 0..1 |
| ElectronicSequenceNumber | Sequential number of the report, as assigned by the account servicer. | Usage: The sequential number is increased incrementally for each report sent electronically. |
| ReportingSequence | Specifies the range of identification sequence numbers, as provided in the request. | ISequenceRange1Choice - Optional 0..1 |
| LegalSequenceNumber | Legal sequential number of the report, as assigned by the account servicer. It is increased incrementally for each report sent. | IsoNumber - Optional 0..1 |
| CreationDateTime | Date and time at which the report was created. | IsoISODateTime - Optional 0..1 |
| FromToDate | Range of time between a start date and an end date for which the account report is issued. | DateTimePeriod1 - 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. | CashAccount39 - Required 1..1 |
| RelatedAccount | Identifies the parent account of the account for which the report has been issued. | CashAccount38 - Optional 0..1 |
| Interest | Provides general interest information that applies to the account at a particular moment in time. | AccountInterest4 - Unknown 0..0 |
| Balance | Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account at a specific point in time. | CashBalance8 - Unknown 0..0 |
| TransactionsSummary | Provides summary information on entries. | TotalTransactions6 - Optional 0..1 |
| Entry | Specifies an entry in the report. Usage: At least one reference must be provided to identify the entry and its underlying transaction(s). Usage Rule: In case of a Payments R-transaction the creditor / debtor referenced of the original payment initiation messages is also used for reporting of the R-transaction. The original debtor/creditor in the reporting of R-Transactions is not inverted. Following elements all defined in the TransactionDetails in RelatedParties or RelatedAgents are impacted by this usage rule: Creditor, UltimateCreditor, CreditorAccount, CreditorAgent, Debtor, UltimateDebtor, DebtorAccount and DebtorAgent. | ReportEntry10 - Unknown 0..0 |
| AdditionalReportInformation | Further details of the account report. | 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 BankToCustomerAccountReportV08 implementation follows a specific implementaiton pattern. First of all, BankToCustomerAccountReportV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BankToCustomerAccountReportV08Document implements IOuterDocument. Because BankToCustomerAccountReportV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BankToCustomerAccountReportV08.
classDiagram
class IOuterRecord
BankToCustomerAccountReportV08 --|> IOuterRecord : Implements
BankToCustomerAccountReportV08Document --|> IOuterDocument~BankToCustomerAccountReportV08~ : Implements
class IOuterDocument~BankToCustomerAccountReportV08~ {
BankToCustomerAccountReportV08 Message
}
Document wrapper for serialization
The only real purpose BankToCustomerAccountReportV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.052.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BankToCustomerAccountReportV08.ToDocument() method. The returned BankToCustomerAccountReportV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram
BankToCustomerAccountReportV08Document *-- BankToCustomerAccountReportV08 : 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.052.001.08">
<BkToCstmrAcctRpt>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Rpt>
<!-- Report inner content -->
</Rpt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</BkToCstmrAcctRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_eYI_SW2PEei3KuUgpx7Xcw"
nextVersions="_7wrvndb-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbSV1rEeehlLdFiIrRgQ"
name="BankToCustomerAccountReportV08"
definition="Scope
The BankToCustomerAccountReport 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 the entries reported to the account, and/or to provide the owner with balance information on the account at a given point in time.
Usage
The BankToCustomerAccountReport 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;
- provide balance information.
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).
For a statement, the Bank-to-Customer Account Statement message should be used."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="BkToCstmrAcctRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_eYI_S22PEei3KuUgpx7Xcw"
nextVersions="_7wrvn9b-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbS11rEeehlLdFiIrRgQ"
name="MessageOrReportPaginationRule"
definition="MessagePagination may be present or ReportPagination 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>/Report[*]/ReportPagination</leftOperand></BooleanRule></mustBe></SimpleRule></RuleDefinition>" />
<constraint
xmi:id="_eYI_TW2PEei3KuUgpx7Xcw"
nextVersions="_7wrvodb-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbTV1rEeehlLdFiIrRgQ"
name="SupplementaryDataRule"
definition="The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_eYI_T22PEei3KuUgpx7Xcw"
nextVersions="_7wrvqdb-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbT11rEeehlLdFiIrRgQ"
name="GroupHeader"
definition="Common information for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_I5uXpW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_UW2PEei3KuUgpx7Xcw"
nextVersions="_7wrvq9b-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbUV1rEeehlLdFiIrRgQ"
name="Report"
definition="Reports on a cash account."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Rpt"
complexType="_WUcQUW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_U22PEei3KuUgpx7Xcw"
nextVersions="_7wrvrdb-Eeq_l4BJLVUF2Q"
previousVersion="_XlRbU11rEeehlLdFiIrRgQ"
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="052"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.