camt.005.001.10
Scope The GetTransaction message is sent by a member to the transaction administrator. It is used to request information about payment instructions held at the transaction administrator. Payment instructions are either sent by the member, debiting or crediting its account at the transaction administrator or received by the transaction administrator, crediting or debiting the member’s account. Usage Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, or because of risk or liquidity limits, etc.). A transaction may have a series of statuses. These can be transient (such as pending or related types) and final (such as rejected, revoked and/or settled). Members of a system need to have information about the payments queue(s) and must have the ability to take action (that is, to cancel or modify the transaction(s) to be settled). Note, however, that actions by a member will always concern transactions in a transient status. At any time during the operating hours of the system, the member can query the transaction administrator to get information about transactions, whatever their status. These requests will concern either all transactions, all transactions with a particular status or a specific transaction. The member can request information about transactions through a series of criteria, corresponding to the known information stored at the transaction administrator, based on the following elements:
- provenance or destination of the payment (payment to/payment from)
- transaction reference
- transfer value date
- payment instruction reference
- payment instruction status, as registered at the transaction administrator
- instructed amount and/or currency
- interbank settlement amount and/or currency
- credit/debit indicator of the payment instruction/transaction
- SWIFT FIN payment message used for the payment instruction
- priority of the payment transaction
- period in which the payment instruction should be processed (processing validity time)
- instructions given, related to the processing of the transaction
- type of payment instructed
- account identification (entries booked to a specific account)
- entry amount and/or currency
- entry debit/credit indicator (if absent, all entries should be reported).
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
%% GetTransactionV10 recursion level 0 with max 0
GetTransactionV10 *-- "1..1" MessageHeader9 : MessageHeader
GetTransactionV10 *-- "0..1" TransactionQuery7 : TransactionQueryDefinition
GetTransactionV10 *-- "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 |
TransactionQueryDefinition building block
Defines the transaction query criteria. Defines the query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% TransactionQuery7 recursion level 0 with max 1
class TransactionQuery7{
QueryType QueryType2Code
}
TransactionQuery7 *-- "0..1" ITransactionCriteria7Choice : TransactionCriteria
%% ITransactionCriteria7Choice recursion level 1 with max 1
TransactionQuery7 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 |
| TransactionCriteria | Defines the payment transaction query criteria. | ITransactionCriteria7Choice - 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 GetTransactionV10 implementation follows a specific implementaiton pattern. First of all, GetTransactionV10 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetTransactionV10Document implements IOuterDocument. Because GetTransactionV10 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetTransactionV10.
classDiagram
class IOuterRecord
GetTransactionV10 --|> IOuterRecord : Implements
GetTransactionV10Document --|> IOuterDocument~GetTransactionV10~ : Implements
class IOuterDocument~GetTransactionV10~ {
GetTransactionV10 Message
}
Document wrapper for serialization
The only real purpose GetTransactionV10Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.005.001.10’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetTransactionV10.ToDocument() method. The returned GetTransactionV10Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetTransactionV10Document *-- GetTransactionV10 : 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.005.001.10">
<GetTx>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<TxQryDef>
<!-- TransactionQueryDefinition inner content -->
</TxQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetTx>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jx3fgQKxEe2rHs6fbn9-0A"
previousVersion="_ThPM_db6Eeq_l4BJLVUF2Q"
name="GetTransactionV10"
definition="Scope
The GetTransaction message is sent by a member to the transaction administrator.
It is used to request information about payment instructions held at the transaction administrator. Payment instructions are either sent by the member, debiting or crediting its account at the transaction administrator or received by the transaction administrator, crediting or debiting the member's account.
Usage
Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, or because of risk or liquidity limits, etc.). A transaction may have a series of statuses. These can be transient (such as pending or related types) and final (such as rejected, revoked and/or settled).
Members of a system need to have information about the payments queue(s) and must have the ability to take action (that is, to cancel or modify the transaction(s) to be settled). Note, however, that actions by a member will always concern transactions in a transient status.
At any time during the operating hours of the system, the member can query the transaction administrator to get information about transactions, whatever their status.
These requests will concern either all transactions, all transactions with a particular status or a specific transaction.
The member can request information about transactions through a series of criteria, corresponding to the known information stored at the transaction administrator, based on the following elements:
- provenance or destination of the payment (payment to/payment from)
- transaction reference
- transfer value date
- payment instruction reference
- payment instruction status, as registered at the transaction administrator
- instructed amount and/or currency
- interbank settlement amount and/or currency
- credit/debit indicator of the payment instruction/transaction
- SWIFT FIN payment message used for the payment instruction
- priority of the payment transaction
- period in which the payment instruction should be processed (processing validity time)
- instructions given, related to the processing of the transaction
- type of payment instructed
- account identification (entries booked to a specific account)
- entry amount and/or currency
- entry debit/credit indicator (if absent, all entries should be reported)."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="GetTx"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jx4GlwKxEe2rHs6fbn9-0A"
previousVersion="_ThPNA9b6Eeq_l4BJLVUF2Q"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_jAUZkZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jx4GmQKxEe2rHs6fbn9-0A"
previousVersion="_ThPNBdb6Eeq_l4BJLVUF2Q"
name="TransactionQueryDefinition"
definition="Defines the transaction query criteria."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="TxQryDef"
complexType="_8_lFIQKxEe2rHs6fbn9-0A" />
<messageBuildingBlock
xmi:id="_jx4GmwKxEe2rHs6fbn9-0A"
previousVersion="_ThPNB9b6Eeq_l4BJLVUF2Q"
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="005"
flavour="001"
version="10" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.