cain.021.001.02
The RetrievalInitiation message is sent by an issuer or agent to an acquirer to retrieve the original transaction details.
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
%% RetrievalInitiationV02 recursion level 0 with max 0
RetrievalInitiationV02 *-- "1..1" Header67 : Header
RetrievalInitiationV02 *-- "1..1" RetrievalInitiation2 : Body
RetrievalInitiationV02 *-- "0..1" ContentInformationType20 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Information related to the protocol management. Set of characteristics related to the protocol. Header for a retrieval message. ISO 8583 MTI For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header67 recursion level 0 with max 1
class Header67{
MessageFunction MessageFunction45Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header67 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header67 *-- "1..1" GenericIdentification183 : InitiatingParty
Header67 *-- "0..1" GenericIdentification183 : RecipientParty
Header67 *-- "0..0" AdditionalData1 : TraceData
Header67 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
CollectionIdentification IsoMax35Text
BatchIdentification IsoMax35Text
MessageSequenceNumber IsoMax15NumericText
MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country ISOMax3ACountryCode
ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country ISOMax3ACountryCode
ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
Type IsoMax35Text
Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification
Header67 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction45Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax2048Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange of messages between two parties. | IsoMax35Text - Optional 0..1 |
| ReTransmissionCounter | Number of retransmission of the message. Incremented by one for each retransmission. | IsoMax3NumericText - Optional 0..1 |
| CreationDateTime | Date and time at which the message was sent. | IsoISODateTime - Required 1..1 |
| BatchManagementInformation | Information related to the batch and the collection to which the message belongs if any. | BatchManagementInformation1 - Optional 0..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification183 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification183 - Optional 0..1 |
| TraceData | Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability9 - Unknown 0..0 |
Body building block
Information related to the initiation of a retrieval of information. Information related to the retrieval of a message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RetrievalInitiation2 recursion level 0 with max 1
RetrievalInitiation2 *-- "1..1" Environment21 : Environment
RetrievalInitiation2 *-- "1..1" Context15 : Context
RetrievalInitiation2 *-- "0..1" Transaction136 : Transaction
RetrievalInitiation2 *-- "1..1" OriginalTransaction2 : OriginalTransaction
RetrievalInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
RetrievalInitiation2 *-- "0..1" PartyIdentification258 : RetrievalFulfilmentDestination
RetrievalInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment21 recursion level 1 with max 1
Environment21 *-- "1..1" PartyIdentification263 : Acquirer
Environment21 *-- "0..1" PartyIdentification263 : Originator
Environment21 *-- "0..1" PartyIdentification263 : Sender
Environment21 *-- "0..1" PartyIdentification263 : Receiver
Environment21 *-- "0..1" PartyIdentification255 : Acceptor
Environment21 *-- "0..1" PartyIdentification263 : Destination
Environment21 *-- "0..1" PartyIdentification257 : Payer
Environment21 *-- "0..1" PartyIdentification257 : Payee
Environment21 *-- "0..1" Terminal6 : Terminal
Environment21 *-- "0..1" PartyIdentification263 : Issuer
Environment21 *-- "1..1" CardData10 : Card
Environment21 *-- "0..1" Wallet2 : Wallet
Environment21 *-- "0..1" Token2 : Token
%% Context15 recursion level 1 with max 1
Context15 *-- "0..1" PointOfServiceContext5 : PointOfServiceContext
Context15 *-- "1..1" TransactionContext8 : TransactionContext
Context15 *-- "0..1" SaleContext8 : SaleContext
%% Transaction136 recursion level 1 with max 1
class Transaction136{
MessageReason ISO8583MessageReasonCode
AlternateMessageReason IsoMax256Text
TransactionDescription IsoMax1000Text
}
Transaction136 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction136 *-- "1..1" TransactionIdentification18 : TransactionIdentification
Transaction136 *-- "0..0" DisputeData3 : DisputeData
Transaction136 *-- "0..0" RetrievalFulfilmentInstructions2 : RetrievalFulfilmentInstructions
Transaction136 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction136 *-- "0..0" AdditionalData1 : AdditionalData
%% OriginalTransaction2 recursion level 1 with max 1
OriginalTransaction2 *-- "0..1" Environment20 : Environment
OriginalTransaction2 *-- "0..1" Context12 : Context
OriginalTransaction2 *-- "0..1" Transaction147 : Transaction
OriginalTransaction2 *-- "0..1" ProcessingResult10 : ProcessingResult
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% PartyIdentification258 recursion level 1 with max 1
class PartyIdentification258{
Identification IsoMax35Text
Assigner IsoMax35Text
Country ISO3NumericCountryCode
ShortName IsoMax35Text
LegalCorporateName IsoMax99Text
}
PartyIdentification258 *-- "0..1" AdditionalData1 : AdditionalIdentification
PartyIdentification258 *-- "0..1" LocalData1 : LocalData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
RetrievalInitiation2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | Environment21 - Required 1..1 |
| Context | Context of the transaction. | Context15 - Required 1..1 |
| Transaction | Original transaction for which a retrieval is requested. | Transaction136 - Optional 0..1 |
| OriginalTransaction | Contains details of the transaction to be retrieved. | OriginalTransaction2 - Required 1..1 |
| ProtectedData | Contains protected data and the attributes used to protect the data. | ProtectedData1 - Unknown 0..0 |
| RetrievalFulfilmentDestination | Destination ID or routing information of Retrieval fulfilment initiation message. | PartyIdentification258 - Optional 0..1 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or other specific block. | SupplementaryData1 - Unknown 0..0 |
SecurityTrailer building block
Trailer of the message containing a MAC. It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128. General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
Control IsoExact1HexBinaryText
KeySetIdentifier IsoMax8NumericText
DerivedInformation IsoMax32HexBinaryText
Algorithm IsoMax2NumericText
KeyLength IsoMax4NumericText
KeyProtection IsoMax2NumericText
KeyIndex IsoMax5NumericText
PaddingMethod IsoMax2NumericText
InitialisationVector IsoMax32HexBinaryText
}
ContentInformationType20 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MACData | Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 | MACData1 - Required 1..1 |
| MAC | Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 | IsoMax8HexBinaryText - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the RetrievalInitiationV02 implementation follows a specific implementaiton pattern. First of all, RetrievalInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RetrievalInitiationV02Document implements IOuterDocument. Because RetrievalInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RetrievalInitiationV02.
classDiagram
class IOuterRecord
RetrievalInitiationV02 --|> IOuterRecord : Implements
RetrievalInitiationV02Document --|> IOuterDocument~RetrievalInitiationV02~ : Implements
class IOuterDocument~RetrievalInitiationV02~ {
RetrievalInitiationV02 Message
}
Document wrapper for serialization
The only real purpose RetrievalInitiationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.021.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RetrievalInitiationV02.ToDocument() method. The returned RetrievalInitiationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RetrievalInitiationV02Document *-- RetrievalInitiationV02 : 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:cain.021.001.02">
<RtrvlInitn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</RtrvlInitn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_e0SsAYHUEeuwq_rv81SdXw"
previousVersion="_IcTD1FaCEeeFltjJxERUxw"
name="RetrievalInitiationV02"
definition="The RetrievalInitiation message is sent by an issuer or agent to an acquirer to retrieve the original transaction details."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="RtrvlInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_e0SsA4HUEeuwq_rv81SdXw"
previousVersion="_IcTD11aCEeeFltjJxERUxw"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_bF7d0RypEey6gI8SKlv7rg" />
<messageBuildingBlock
xmi:id="_e0SsBYHUEeuwq_rv81SdXw"
previousVersion="_IcTD1laCEeeFltjJxERUxw"
name="Body"
definition="Information related to the initiation of a retrieval of information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_o0ZJ4YHSEeuwq_rv81SdXw" />
<messageBuildingBlock
xmi:id="_e0SsB4HUEeuwq_rv81SdXw"
previousVersion="_IcTD1VaCEeeFltjJxERUxw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC.
It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
<messageDefinitionIdentifier
businessArea="cain"
messageFunctionality="021"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.