cain.006.001.01
The AcquirerReversalResponse message is sent by an issuer or an agent to answer to an AcquirerReversalInitiation 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
%% AcquirerReversalResponse recursion level 0 with max 0
AcquirerReversalResponse *-- "1..1" Header18 : Header
AcquirerReversalResponse *-- "1..1" AcquirerReversalResponse1 : ReversalResponse
AcquirerReversalResponse *-- "0..1" ContentInformationType15 : 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. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header18 recursion level 0 with max 1
class Header18{
MessageFunction MessageFunction6Code
OriginalMessageFunction MessageFunction6Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header18 *-- "1..1" GenericIdentification73 : InitiatingParty
Header18 *-- "0..1" GenericIdentification73 : RecipientParty
Header18 *-- "0..0" Traceability3 : Traceability
%% GenericIdentification73 recursion level 1 with max 1
class GenericIdentification73{
Identification IsoMax35Text
Type PartyType9Code
Issuer PartyType9Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification73 recursion level 1 with max 1
class GenericIdentification73{
Identification IsoMax35Text
Type PartyType9Code
Issuer PartyType9Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% Traceability3 recursion level 1 with max 1
class Traceability3{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability3 *-- "1..1" GenericIdentification74 : RelayIdentification
Header18 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction6Code - Required 1..1 |
| OriginalMessageFunction | Identifies the type of process related to the message which has to be reversed. | MessageFunction6Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
| ReTransmissionCounter | Number of retransmission of the message. Incremented by 1 for each retransmission. | IsoMax3NumericText - Optional 0..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification73 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification73 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability3 - Unknown 0..0 |
ReversalResponse building block
Information related to the response of a reversal. Information related to the response of a reversal. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcquirerReversalResponse1 recursion level 0 with max 1
AcquirerReversalResponse1 *-- "1..1" CardTransactionEnvironment4 : Environment
AcquirerReversalResponse1 *-- "1..1" CardTransaction8 : Transaction
%% CardTransactionEnvironment4 recursion level 1 with max 1
class CardTransactionEnvironment4{
AcquirerIdentification IsoMax35Text
CardSchemeIdentification IsoMax35Text
AcceptorIdentification IsoMax35Text
TerminalIdentification IsoMax35Text
}
CardTransactionEnvironment4 *-- "1..1" PaymentCard15 : Card
CardTransactionEnvironment4 *-- "0..1" CardPaymentToken2 : PaymentToken
%% CardTransaction8 recursion level 1 with max 1
class CardTransaction8{
TransactionType CardPaymentServiceType7Code
AcceptorTransactionDateTime IsoISODateTime
InitiatorTransactionIdentification IsoMax35Text
TransactionLifeCycleIdentification IsoMax35Text
TransactionLifeCycleSequenceNumber IsoNumber
TransactionLifeCycleSequenceCounter IsoNumber
}
CardTransaction8 *-- "0..1" TransactionIdentifier2 : Reconciliation
CardTransaction8 *-- "1..1" CardTransactionDetail6 : TransactionDetails
CardTransaction8 *-- "1..1" ResponseType2 : TransactionResponse
AcquirerReversalResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardTransactionEnvironment4 - Required 1..1 |
| Transaction | Reversal card transaction. | CardTransaction8 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType15 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcquirerReversalResponse implementation follows a specific implementaiton pattern. First of all, AcquirerReversalResponse impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcquirerReversalResponseDocument implements IOuterDocument. Because AcquirerReversalResponse implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcquirerReversalResponse.
classDiagram
class IOuterRecord
AcquirerReversalResponse --|> IOuterRecord : Implements
AcquirerReversalResponseDocument --|> IOuterDocument~AcquirerReversalResponse~ : Implements
class IOuterDocument~AcquirerReversalResponse~ {
AcquirerReversalResponse Message
}
Document wrapper for serialization
The only real purpose AcquirerReversalResponseDocument serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.006.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcquirerReversalResponse.ToDocument() method. The returned AcquirerReversalResponseDocument value will serialize correctly according to ISO 20022 standards.
classDiagram
AcquirerReversalResponseDocument *-- AcquirerReversalResponse : 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.006.001.01">
<AcqrrRvslRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RvslRspn>
<!-- ReversalResponse inner content -->
</RvslRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AcqrrRvslRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Se9ukHu2EeS2Z_kGi7H1VQ"
nextVersions="_7CK1lVUDEeetiruPyDPo0Q"
name="AcquirerReversalResponse"
definition="The AcquirerReversalResponse message is sent by an issuer or an agent to answer to an AcquirerReversalInitiation message."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AcqrrRvslRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_cIqMsHu2EeS2Z_kGi7H1VQ"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_LJERUXuxEeS2Z_kGi7H1VQ" />
<messageBuildingBlock
xmi:id="_umfZ8Hu2EeS2Z_kGi7H1VQ"
name="ReversalResponse"
definition="Information related to the response of a reversal."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RvslRspn"
complexType="_mdPa4Hu2EeS2Z_kGi7H1VQ" />
<messageBuildingBlock
xmi:id="_kiQwIIOyEeSWSLYdc10LRg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="cain"
messageFunctionality="006"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.