camt.006.001.09
Scope The ReturnTransaction message is sent by the transaction administrator to a member of the system. It is used to provide information on transactions and booked entries held at the transaction administrator. The Return Transaction message can be sent as a response to a related GetTransaction 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 Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, 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 or settled). Members of a system need to receive information about the payments queue(s) and must have the ability to take action (that is, 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 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 within 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 within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that match the request and report them to the requester. The transaction administrator may also send a ReturnTransaction 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:
- 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
- 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)
- status of the entry (pending, booked.)
- entry date and time
- currency of the account
- type of the account
- entry reference
- entry date
- transfer reason
- details related to the status of the payment instruction An element that is particular to the Get/Return Transaction pair is the Statement Report. When a GetTransaction message is sent requesting a statement report, the related ReturnTransaction message will provide a pre-defined set of return criteria per transaction. The information returned contains the following details for each transaction:
- value date
- entry date
- debit/credit code
- entry amount
- method of payment (payment instrument or message type)
- entry reference
- transaction reference
- supplementary details 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
%% ReturnTransactionV09 recursion level 0 with max 0
ReturnTransactionV09 *-- "1..1" MessageHeader8 : MessageHeader
ReturnTransactionV09 *-- "1..1" ITransactionReportOrError5Choice : ReportOrError
ReturnTransactionV09 *-- "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
%% MessageHeader8 recursion level 0 with max 1
class MessageHeader8{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader8 *-- "0..1" Pagination1 : MessagePagination
MessageHeader8 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
MessageHeader8 *-- "0..1" IRequestType4Choice : RequestType
%% 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
}
%% IRequestType4Choice recursion level 1 with max 1
MessageHeader8 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 |
| MessagePagination | Pagination of the message. | Usage: the pagination of the message is only allowed when agreed between the parties. |
| OriginalBusinessQuery | Unique identification of the original query message. | OriginalBusinessQuery1 - Optional 0..1 |
| RequestType | Specific actions to be executed through the request. | IRequestType4Choice - 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 transactions. Choice between transactions and booked entries held at the transaction administrator or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ITransactionReportOrError5Choice recursion level 0 with max 1
TransactionReportOrError5Choice 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 ReturnTransactionV09 implementation follows a specific implementaiton pattern. First of all, ReturnTransactionV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReturnTransactionV09Document implements IOuterDocument. Because ReturnTransactionV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReturnTransactionV09.
classDiagram
class IOuterRecord
ReturnTransactionV09 --|> IOuterRecord : Implements
ReturnTransactionV09Document --|> IOuterDocument~ReturnTransactionV09~ : Implements
class IOuterDocument~ReturnTransactionV09~ {
ReturnTransactionV09 Message
}
Document wrapper for serialization
The only real purpose ReturnTransactionV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.006.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReturnTransactionV09.ToDocument() method. The returned ReturnTransactionV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ReturnTransactionV09Document *-- ReturnTransactionV09 : 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.006.001.09">
<RtrTx>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RtrTx>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_ThWhy9b6Eeq_l4BJLVUF2Q"
nextVersions="_jx4toQKxEe2rHs6fbn9-0A"
previousVersion="_jwlcORbvEeiyVv5j1vf1VQ"
name="ReturnTransactionV09"
definition="Scope
The ReturnTransaction message is sent by the transaction administrator to a member of the system.
It is used to provide information on transactions and booked entries held at the transaction administrator.
The Return Transaction message can be sent as a response to a related GetTransaction 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
Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, 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 or settled).
Members of a system need to receive information about the payments queue(s) and must have the ability to take action (that is, 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 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 within 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 within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that match the request and report them to the requester.
The transaction administrator may also send a ReturnTransaction 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:
- 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
- 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)
- status of the entry (pending, booked.)
- entry date and time
- currency of the account
- type of the account
- entry reference
- entry date
- transfer reason
- details related to the status of the payment instruction
An element that is particular to the Get/Return Transaction pair is the Statement Report. When a GetTransaction message is sent requesting a statement report, the related ReturnTransaction message will provide a pre-defined set of return criteria per transaction. The information returned contains the following details for each transaction:
- value date
- entry date
- debit/credit code
- entry amount
- method of payment (payment instrument or message type)
- entry reference
- transaction reference
- supplementary details
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="_S0OMdGY1EeuQ__SOdbf47A"
xmlTag="RtrTx"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_ThWhzdb6Eeq_l4BJLVUF2Q"
nextVersions="_jx4towKxEe2rHs6fbn9-0A"
previousVersion="_jwlcOxbvEeiyVv5j1vf1VQ"
name="CurrencyGuideline"
definition="The currency may be omitted in the amounts present in the message. However, this should only be done in cases of one single currency systems (for example, the euro)."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_ThWh1db6Eeq_l4BJLVUF2Q"
nextVersions="_jx4trQKxEe2rHs6fbn9-0A"
previousVersion="_jwlcPRbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_i375p5IhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_ThWh19b6Eeq_l4BJLVUF2Q"
nextVersions="_jx4trwKxEe2rHs6fbn9-0A"
previousVersion="_jwlcPxbvEeiyVv5j1vf1VQ"
name="ReportOrError"
definition="Reports on transactions."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_dc83EdcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_ThWh2db6Eeq_l4BJLVUF2Q"
nextVersions="_jx4tsQKxEe2rHs6fbn9-0A"
previousVersion="_jwlcQRbvEeiyVv5j1vf1VQ"
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="006"
flavour="001"
version="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.