ReturnAccountV09

camt.004.001.09

Scope The ReturnAccount message is sent by the transaction administrator to a member. It is used to provide information on the details of one or more accounts held at the transaction administrator, including information on the balances. The Return Account message can be sent as a response to a related GetAccount message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred. Usage At any time during the operating hours of the system, the member can query the transaction administrator to get information about the account(s) that the transaction administrator maintains for the member. For example, this may be necessary in order to perform the appropriate liquidity management and the necessary funds transfers between accounts. The member can request information about accounts through a series of criteria, corresponding to the known information stored at the transaction administrator. The query can concern one or more specific accounts, accounts of a particular identification, or a particular type. The purpose of the query may be to obtain one or more types of balance. The transaction administrator may also send a ReturnAccount message with pre-defined information, at times previously agreed with the member, or to warn the member about a particular problem that may have arisen and which needs attention. The message from the transaction administrator can contain information based on the following elements:

account identification
account name
account type (this is used when the account identification represents, for example, a group of accounts)
currency of the account (this is used for example when the account identification represents a group of account in various currencies, or when it is a multi-currency account with one single identifier)
type of balance (if not present in the GetAccount message, all balances will be reported)
bilateral or multilateral limits
related counterparty (when the limit or balance is bilateral)
balance value date (if not present in the GetAccount message, the ReturnAccount message will contain the latest available balance)
number of payments to the additional account information on the generic design of the Get/Return messages can be found in the section How to Use the Cash Management Messages.

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
%% ReturnAccountV09 recursion level 0 with max 0
ReturnAccountV09 *-- "1..1" MessageHeader7 : MessageHeader
ReturnAccountV09 *-- "1..1" IAccountOrOperationalError5Choice : ReportOrError
ReturnAccountV09 *-- "0..1" SupplementaryData1 : SupplementaryData

Now, we will zero-in one-by-one on each of these building blocks.

MessageHeader building block

Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageHeader7 recursion level 0 with max 1
class MessageHeader7{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    QueryName IsoMax35Text
}
MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType4Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageHeader7 members

Member name	Description	Data Type / Multiplicity
MessageIdentification	Point to point reference, as assigned by the sender, to unambiguously identify the message.	Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period.
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Optional 0..1
RequestType	Specific actions to be executed through the request.	IRequestType4Choice - Optional 0..1
OriginalBusinessQuery	Unique identification of the original query message.	OriginalBusinessQuery1 - Optional 0..1
QueryName	Recalls the criteria (search and return criteria) defined in a preceding query.	IsoMax35Text - Optional 0..1

ReportOrError building block

Reports on accounts. Choice between account details or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IAccountOrOperationalError5Choice recursion level 0 with max 1

AccountOrOperationalError5Choice members

Member name	Description	Data Type / Multiplicity

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 ReturnAccountV09 implementation follows a specific implementaiton pattern. First of all, ReturnAccountV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReturnAccountV09Document implements IOuterDocument. Because ReturnAccountV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReturnAccountV09.

classDiagram
    class IOuterRecord
    ReturnAccountV09 --|> IOuterRecord : Implements
    ReturnAccountV09Document --|> IOuterDocument~ReturnAccountV09~ : Implements
    class IOuterDocument~ReturnAccountV09~ {
        ReturnAccountV09 Message
     }

Document wrapper for serialization

The only real purpose ReturnAccountV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.004.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReturnAccountV09.ToDocument() method. The returned ReturnAccountV09Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ReturnAccountV09Document *-- ReturnAccountV09 : 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.004.001.09">
    <RtrAcct>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <RptOrErr>
            <!-- ReportOrError inner content -->
        </RptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </RtrAcct>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ThVTq9b6Eeq_l4BJLVUF2Q"
  previousVersion="_jwlb-RbvEeiyVv5j1vf1VQ"
  name="ReturnAccountV09"
  definition="Scope&#xA;The ReturnAccount message is sent by the transaction administrator to a member.&#xA;It is used to provide information on the details of one or more accounts held at the transaction administrator, including information on the balances.&#xA;The Return Account message can be sent as a response to a related GetAccount message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred.&#xA;Usage&#xA;At any time during the operating hours of the system, the member can query the transaction administrator to get information about the account(s) that the transaction administrator maintains for the member.&#xA;For example, this may be necessary in order to perform the appropriate liquidity management and the necessary funds transfers between accounts.&#xA;The member can request information about accounts through a series of criteria, corresponding to the known information stored at the transaction administrator.&#xA;The query can concern one or more specific accounts, accounts of a particular identification, or a particular type. The purpose of the query may be to obtain one or more types of balance.&#xA;The transaction administrator may also send a ReturnAccount message with pre-defined information, at times previously agreed with the member, or to warn the member about a particular problem that may have arisen and which needs attention.&#xA;The message from the transaction administrator can contain information based on the following elements: &#xA;- account identification&#xA;- account name&#xA;- account type (this is used when the account identification represents, for example, a group of accounts)&#xA;- currency of the account (this is used for example when the account identification represents a group of account in various currencies, or when it is a multi-currency account with one single identifier)&#xA;- type of balance (if not present in the GetAccount message, all balances will be reported)&#xA;- bilateral or multilateral limits&#xA;- related counterparty (when the limit or balance is bilateral)&#xA;- balance value date (if not present in the GetAccount message, the ReturnAccount message will contain the latest available balance)&#xA;- number of payments to the additional account information on the generic design of the Get/Return messages can be found in the section How to Use the Cash Management Messages."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="RtrAcct"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ThVTs9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlb-xbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_imfkUZIhEeect698_YsnIA" />
  <messageBuildingBlock
    xmi:id="_ThVTtdb6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlb_RbvEeiyVv5j1vf1VQ"
    name="ReportOrError"
    definition="Reports on accounts."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptOrErr"
    complexType="_fAfGYdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_ThVTt9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlb_xbvEeiyVv5j1vf1VQ"
    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="004"
    flavour="001"
    version="09" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.