camt.003.001.07
Scope The GetAccount message is sent by a member to the transaction administrator. It is used to request information on the details of one or more accounts held at the transaction administrator, including information on the balances. 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 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 member can request information based on the following elements:
- account identification
- account type (this element can be used to refine the query when the account identification represents, for example, a group of accounts)
- balance type (if not present, all balances are requested)
- type of counterparty: bilateral or multilateral (note that, by default, a balance is multilateral unless a particular counterparty is specified)
- identification of the counterparty when a bilateral balance is requested
- balance value date (if not present in the GetAccount message, the ReturnAccount message will contain the latest available balance) This message will be answered by a ReturnAccount message. Additional 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
%% GetAccountV07 recursion level 0 with max 0
GetAccountV07 *-- "1..1" MessageHeader9 : MessageHeader
GetAccountV07 *-- "0..1" AccountQuery3 : AccountQueryDefinition
GetAccountV07 *-- "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
%% MessageHeader9 recursion level 0 with max 1
class MessageHeader9{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader9 *-- "0..1" IRequestType4Choice : RequestType
%% IRequestType4Choice recursion level 1 with max 1
MessageHeader9 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 |
AccountQueryDefinition building block
Defines the account query criteria. Specification of the query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AccountQuery3 recursion level 0 with max 1
class AccountQuery3{
QueryType QueryType2Code
}
AccountQuery3 *-- "0..1" IAccountCriteria3Choice : AccountCriteria
%% IAccountCriteria3Choice recursion level 1 with max 1
AccountQuery3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| QueryType | Specifies the type of matching items to be returned in the response to the query. | QueryType2Code - Optional 0..1 |
| AccountCriteria | Defines the account query criteria. | IAccountCriteria3Choice - 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 GetAccountV07 implementation follows a specific implementaiton pattern. First of all, GetAccountV07 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetAccountV07Document implements IOuterDocument. Because GetAccountV07 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetAccountV07.
classDiagram
class IOuterRecord
GetAccountV07 --|> IOuterRecord : Implements
GetAccountV07Document --|> IOuterDocument~GetAccountV07~ : Implements
class IOuterDocument~GetAccountV07~ {
GetAccountV07 Message
}
Document wrapper for serialization
The only real purpose GetAccountV07Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.003.001.07’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetAccountV07.ToDocument() method. The returned GetAccountV07Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetAccountV07Document *-- GetAccountV07 : 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.003.001.07">
<GetAcct>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<AcctQryDef>
<!-- AccountQueryDefinition inner content -->
</AcctQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetAcct>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlbZxbvEeiyVv5j1vf1VQ"
name="GetAccountV07"
definition="Scope
The GetAccount message is sent by a member to the transaction administrator.
It is used to request information on the details of one or more accounts held at the transaction administrator, including information on the balances.
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 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 member can request information based on the following elements:
- account identification
- account type (this element can be used to refine the query when the account identification represents, for example, a group of accounts)
- balance type (if not present, all balances are requested)
- type of counterparty: bilateral or multilateral (note that, by default, a balance is multilateral unless a particular counterparty is specified)
- identification of the counterparty when a bilateral balance is requested
- balance value date (if not present in the GetAccount message, the ReturnAccount message will contain the latest available balance)
This message will be answered by a ReturnAccount message.
Additional 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="GetAcct"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlbaRbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_jAUZkZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jwlbaxbvEeiyVv5j1vf1VQ"
name="AccountQueryDefinition"
definition="Defines the account query criteria."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="AcctQryDef"
complexType="_PTgkR249EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_jwlbbRbvEeiyVv5j1vf1VQ"
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="003"
flavour="001"
version="07" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.