ReversalResponseV03

cain.006.001.03

The ReversalResponse message is sent by an issuer or an agent to an acquirer in response to a ReversalInitiation 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
%% ReversalResponseV03 recursion level 0 with max 0
ReversalResponseV03 *-- "1..1" Header62 : Header
ReversalResponseV03 *-- "1..1" ReversalResponse4 : Body
ReversalResponseV03 *-- "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 management of the protocol. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header62 recursion level 0 with max 1
class Header62{
    MessageFunction MessageFunction16Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header62 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header62 *-- "1..1" GenericIdentification183 : InitiatingParty
Header62 *-- "0..1" GenericIdentification183 : RecipientParty
Header62 *-- "0..0" AdditionalData1 : TraceData
Header62 *-- "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
  

Header62 members

Body building block

Information related to the reversal of an authorisation or financial transaction. Information related to the response to a reversal of an authorisation or financial message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReversalResponse4 recursion level 0 with max 1
class ReversalResponse4{
    ICCRelatedData IsoMax10KHexBinaryText
}
ReversalResponse4 *-- "1..1" Environment29 : Environment
ReversalResponse4 *-- "1..1" TransactionContext8 : Context
ReversalResponse4 *-- "1..1" Transaction137 : Transaction
ReversalResponse4 *-- "1..1" ProcessingResult10 : ProcessingResult
ReversalResponse4 *-- "0..0" ProtectedData1 : ProtectedData
ReversalResponse4 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment29 recursion level 1 with max 1
Environment29 *-- "1..1" PartyIdentification263 : Acquirer
Environment29 *-- "0..1" PartyIdentification263 : Originator
Environment29 *-- "0..1" PartyIdentification263 : Sender
Environment29 *-- "0..1" PartyIdentification263 : Receiver
Environment29 *-- "0..1" PartyIdentification258 : Acceptor
Environment29 *-- "0..1" PartyIdentification263 : Destination
Environment29 *-- "0..1" Terminal6 : Terminal
Environment29 *-- "0..1" PartyIdentification263 : Issuer
Environment29 *-- "1..1" CardData10 : Card
Environment29 *-- "0..1" Token2 : Token
%% TransactionContext8 recursion level 1 with max 1
class TransactionContext8{
    MerchantCategoryCode ISO18245MerchantCategoryCode
    MerchantCategorySpecificData IsoMax35Text
    FeeCollectionInitiator FeeCollectionInitiator1Code
    TransactionInitiator TransactionInitiator1Code
    PartialShipmentIndicator IsoTrueFalseIndicator
    DelayedChargesIndicator IsoTrueFalseIndicator
    NoShowIndicator IsoTrueFalseIndicator
    ReauthorisationIndicator IsoTrueFalseIndicator
    ReSubmissionIndicator IsoTrueFalseIndicator
}
TransactionContext8 *-- "0..1" CardProgrammeMode3 : CardProgrammeApplied
TransactionContext8 *-- "0..1" Jurisdiction2 : Jurisdiction
TransactionContext8 *-- "0..1" SettlementService4 : SettlementService
TransactionContext8 *-- "0..1" Reconciliation3 : Reconciliation
TransactionContext8 *-- "0..0" AdditionalData1 : AdditionalData
%% Transaction137 recursion level 1 with max 1
class Transaction137{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute2Code
    OtherTransactionAttribute IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction137 *-- "0..0" AdditionalService2 : AdditionalService
Transaction137 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction137 *-- "1..1" TransactionIdentification51 : TransactionIdentification
Transaction137 *-- "1..1" TransactionAmounts2 : TransactionAmounts
Transaction137 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction137 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction137 *-- "0..0" AdditionalFee2 : OriginalAdditionalFee
Transaction137 *-- "0..1" AccountDetails3 : AccountFrom
Transaction137 *-- "0..1" AccountDetails3 : AccountTo
Transaction137 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult10 recursion level 1 with max 1
class ProcessingResult10{
    ApprovalCode IsoExact6AlphaNumericText
    ActionRequired IsoYesNoIndicator
}
ProcessingResult10 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult10 *-- "1..1" ResultData7 : ResultData
ProcessingResult10 *-- "0..1" ErrorDetails2 : ErrorDetail
ProcessingResult10 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult10 *-- "0..0" Action13 : Action
ProcessingResult10 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult10 *-- "0..0" AdditionalInformation29 : 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
  

ReversalResponse4 members

SecurityTrailer building block

Trailer of the message containing a MAC. 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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the ReversalResponseV03 implementation follows a specific implementaiton pattern. First of all, ReversalResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReversalResponseV03Document implements IOuterDocument. Because ReversalResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReversalResponseV03.

classDiagram
    class IOuterRecord
    ReversalResponseV03 --|> IOuterRecord : Implements
    ReversalResponseV03Document --|> IOuterDocument~ReversalResponseV03~ : Implements
    class IOuterDocument~ReversalResponseV03~ {
        ReversalResponseV03 Message
     }
  

Document wrapper for serialization

The only real purpose ReversalResponseV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.006.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReversalResponseV03.ToDocument() method. The returned ReversalResponseV03Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ReversalResponseV03Document *-- ReversalResponseV03 : 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.03">
    <RvslRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </RvslRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_1UjKQYwDEeuC5632vxUfGg"
  previousVersion="_7CK1lVUDEeetiruPyDPo0Q"
  name="ReversalResponseV03"
  definition="The ReversalResponse message is sent by an issuer or an agent to an acquirer in response to a ReversalInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="RvslRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_1UjKQ4wDEeuC5632vxUfGg"
    previousVersion="_7CK1mFUDEeetiruPyDPo0Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_yws50RvUEey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_1UjKRYwDEeuC5632vxUfGg"
    previousVersion="_7CK1mVUDEeetiruPyDPo0Q"
    name="Body"
    definition="Information related to the reversal of an authorisation or financial transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_7yoA8YwDEeuC5632vxUfGg" />
  <messageBuildingBlock
    xmi:id="_1UjKR4wDEeuC5632vxUfGg"
    previousVersion="_7CK1l1UDEeetiruPyDPo0Q"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="cain"
    messageFunctionality="006"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.