cain.022.001.01
The RetrievalResponse message is sent by an acquirer to an issuer or agent in response to an Retrievalnitiation message.
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
%% RetrievalResponseV01 recursion level 0 with max 0
RetrievalResponseV01 *-- "1..1" Header55 : Header
RetrievalResponseV01 *-- "1..1" RetrievalResponse1 : Body
RetrievalResponseV01 *-- "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
%% Header55 recursion level 0 with max 1
class Header55{
MessageFunction MessageFunction37Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header55 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header55 *-- "1..1" GenericIdentification172 : InitiatingParty
Header55 *-- "0..1" GenericIdentification172 : RecipientParty
Header55 *-- "0..0" AdditionalData1 : TraceData
Header55 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
CollectionIdentification IsoMax35Text
BatchIdentification IsoMax35Text
MessageSequenceNumber IsoMax15NumericText
MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
Type IsoMax35Text
Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
Header55 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction37Code - 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. | GenericIdentification172 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification172 - 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. ISO 8583:93/2003 bit 59 | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability7 - Unknown 0..0 |
Body building block
Information related to the response to the request of a retrieval of information. Information related to the retrieval of a message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RetrievalResponse1 recursion level 0 with max 1
RetrievalResponse1 *-- "1..1" Environment13 : Environment
RetrievalResponse1 *-- "0..1" Context4 : Context
RetrievalResponse1 *-- "0..1" Transaction89 : Transaction
RetrievalResponse1 *-- "1..1" ProcessingResult4 : ProcessingResult
RetrievalResponse1 *-- "0..0" ProtectedData1 : ProtectedData
RetrievalResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment13 recursion level 1 with max 1
Environment13 *-- "1..1" PartyIdentification197 : Acquirer
Environment13 *-- "0..1" PartyIdentification197 : Sender
Environment13 *-- "0..1" PartyIdentification197 : Receiver
Environment13 *-- "0..1" PartyIdentification203 : Acceptor
Environment13 *-- "0..1" PartyIdentification211 : Payer
Environment13 *-- "0..1" PartyIdentification211 : Payee
Environment13 *-- "0..1" Terminal2 : Terminal
Environment13 *-- "1..1" CardData5 : Card
Environment13 *-- "0..1" Wallet1 : Wallet
Environment13 *-- "0..1" Token1 : Token
%% Context4 recursion level 1 with max 1
Context4 *-- "0..1" PointOfServiceContext2 : PointOfServiceContext
Context4 *-- "1..1" TransactionContext3 : TransactionContext
Context4 *-- "0..1" SaleContext7 : SaleContext
%% Transaction89 recursion level 1 with max 1
class Transaction89{
MessageReason IsoExact4NumericText
AlternateMessageReason IsoMax35Text
TransactionDescription IsoMax1000Text
}
Transaction89 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction89 *-- "1..1" TransactionIdentification11 : TransactionIdentification
Transaction89 *-- "0..0" DisputeReference1 : DisputeReference
Transaction89 *-- "0..0" RetrievalFulfilmentInstructions1 : RetrievalFulfilmentInstructions
Transaction89 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction89 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult4 recursion level 1 with max 1
ProcessingResult4 *-- "0..1" ResultData5 : ResultData
ProcessingResult4 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult4 *-- "0..0" AdditionalInformation22 : AdditionalInformation
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
RetrievalResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | Environment13 - Required 1..1 |
| Context | Context of the transaction. | Context4 - Optional 0..1 |
| Transaction | Original transaction for which a retrieval is requested. | Transaction89 - Optional 0..1 |
| ProcessingResult | Outcome of the processing of the authorisation. | ProcessingResult4 - Required 1..1 |
| ProtectedData | Contains protected data and the attributes used to protect the data. | ProtectedData1 - Unknown 0..0 |
| 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 RetrievalResponseV01 implementation follows a specific implementaiton pattern. First of all, RetrievalResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RetrievalResponseV01Document implements IOuterDocument. Because RetrievalResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RetrievalResponseV01.
classDiagram
class IOuterRecord
RetrievalResponseV01 --|> IOuterRecord : Implements
RetrievalResponseV01Document --|> IOuterDocument~RetrievalResponseV01~ : Implements
class IOuterDocument~RetrievalResponseV01~ {
RetrievalResponseV01 Message
}
Document wrapper for serialization
The only real purpose RetrievalResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.022.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RetrievalResponseV01.ToDocument() method. The returned RetrievalResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RetrievalResponseV01Document *-- RetrievalResponseV01 : 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.022.001.01">
<RtrvlRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</RtrvlRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_VMDehFaDEeeFltjJxERUxw"
nextVersions="_w1uw0YHXEeu7P-fjMhpKOg"
name="RetrievalResponseV01"
definition="The RetrievalResponse message is sent by an acquirer to an issuer or agent in response to an Retrievalnitiation message."
registrationStatus="Registered"
messageSet="_oFVkcKmaEeqA4rV5xCgycA"
xmlTag="RtrvlRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_VMDehlaDEeeFltjJxERUxw"
nextVersions="_Xckos-E1EeeV6-yubHrZaQ _w1vX4YHXEeu7P-fjMhpKOg"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_qEndseE8EeeV6-yubHrZaQ" />
<messageBuildingBlock
xmi:id="_VMDehVaDEeeFltjJxERUxw"
nextVersions="_XckoteE1EeeV6-yubHrZaQ _w1vX44HXEeu7P-fjMhpKOg"
name="Body"
definition="Information related to the response to the request of a retrieval of information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_rrccsVaDEeeFltjJxERUxw" />
<messageBuildingBlock
xmi:id="_VMDeh1aDEeeFltjJxERUxw"
nextVersions="_Xckot-E1EeeV6-yubHrZaQ _w1vX5YHXEeu7P-fjMhpKOg"
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="022"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.