ReversalInitiationV02

cain.005.001.02

The ReversalInitiation message is sent by an acquirer, an originator or an agent to an issuer to request or advise of the reversal of an authorisation by the issuer. A reversal is a partial or complete nullification of the effects of a previous authorisation, financial presentment or financial accumulation presentment that cannot be processed as instructed (for example, is undeliverable and cancelled or the acquirer timed out waiting for a response).

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
%% ReversalInitiationV02 recursion level 0 with max 0
ReversalInitiationV02 *-- "1..1" Header42 : Header
ReversalInitiationV02 *-- "1..1" ReversalInitiation1 : Body
ReversalInitiationV02 *-- "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
%% Header42 recursion level 0 with max 1
class Header42{
    MessageFunction MessageFunction16Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header42 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header42 *-- "1..1" GenericIdentification172 : InitiatingParty
Header42 *-- "0..1" GenericIdentification172 : RecipientParty
Header42 *-- "0..0" AdditionalData1 : TraceData
Header42 *-- "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
  

Header42 members

Body building block

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

classDiagram
   direction tb
%% ReversalInitiation1 recursion level 0 with max 1
class ReversalInitiation1{
    ICCRelatedData IsoMax10KHexBinaryText
}
ReversalInitiation1 *-- "1..1" Environment13 : Environment
ReversalInitiation1 *-- "0..1" Context7 : Context
ReversalInitiation1 *-- "1..1" Transaction77 : Transaction
ReversalInitiation1 *-- "0..1" ProcessingResult1 : ProcessingResult
ReversalInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
ReversalInitiation1 *-- "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
%% Context7 recursion level 1 with max 1
Context7 *-- "0..1" PointOfServiceContext2 : PointOfServiceContext
Context7 *-- "0..1" TransactionContext4 : TransactionContext
%% Transaction77 recursion level 1 with max 1
class Transaction77{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute1Code
    OtherTransactionAttribute IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    PreAuthorisationTimeLimit IsoMax6NumericText
    AssociatedDataIndicator IsoTrueFalseIndicator
    AssociatedDataReference IsoMax70Text
    AssociatedDataDestination IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction77 *-- "0..0" AdditionalService1 : AdditionalService
Transaction77 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction77 *-- "1..1" TransactionIdentification8 : TransactionIdentification
Transaction77 *-- "0..0" DisputeData1 : DisputeData
Transaction77 *-- "1..1" TransactionAmounts1 : TransactionAmounts
Transaction77 *-- "0..0" AdditionalAmounts1 : AdditionalAmounts
Transaction77 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction77 *-- "0..0" AdditionalFee1 : OriginalAdditionalFees
Transaction77 *-- "0..0" DepositDetails1 : DepositDetails
Transaction77 *-- "0..1" FundingService1 : FundsServices
Transaction77 *-- "0..1" AccountDetails2 : AccountFrom
Transaction77 *-- "0..1" AccountDetails2 : AccountTo
Transaction77 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult1 recursion level 1 with max 1
class ProcessingResult1{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult1 *-- "0..1" ApprovalData1 : ApprovalData
ProcessingResult1 *-- "0..1" ResultData1 : ResultData
ProcessingResult1 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult1 *-- "0..0" Action9 : Action
ProcessingResult1 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult1 *-- "0..0" AdditionalInformation20 : 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
  

ReversalInitiation1 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 ReversalInitiationV02 implementation follows a specific implementaiton pattern. First of all, ReversalInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReversalInitiationV02Document implements IOuterDocument. Because ReversalInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReversalInitiationV02.

classDiagram
    class IOuterRecord
    ReversalInitiationV02 --|> IOuterRecord : Implements
    ReversalInitiationV02Document --|> IOuterDocument~ReversalInitiationV02~ : Implements
    class IOuterDocument~ReversalInitiationV02~ {
        ReversalInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ReversalInitiationV02Document *-- ReversalInitiationV02 : 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.005.001.02">
    <RvslInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </RvslInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ctEcNVT_EeetiruPyDPo0Q"
  nextVersions="_U0x9oYHOEeuwq_rv81SdXw"
  previousVersion="_6T_xoHuwEeS2Z_kGi7H1VQ"
  name="ReversalInitiationV02"
  definition="The ReversalInitiation message is sent by an acquirer, an originator or an agent to an issuer to request or advise of the reversal of an authorisation by the issuer. A reversal is a partial or complete nullification of the effects of a previous authorisation, financial presentment or financial accumulation presentment that cannot be processed as instructed (for example, is undeliverable and cancelled or the acquirer timed out waiting for a response)."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="RvslInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ctEcNlT_EeetiruPyDPo0Q"
    nextVersions="_U0yksYHOEeuwq_rv81SdXw"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_WZVX0VUAEeetiruPyDPo0Q" />
  <messageBuildingBlock
    xmi:id="_ctEcOVT_EeetiruPyDPo0Q"
    nextVersions="_U0yks4HOEeuwq_rv81SdXw"
    name="Body"
    definition="Information related to the reversal of an authorisation or financial transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_Uw4hZlUCEeetiruPyDPo0Q" />
  <messageBuildingBlock
    xmi:id="_ctEcN1T_EeetiruPyDPo0Q"
    nextVersions="_U0yktYHOEeuwq_rv81SdXw"
    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="005"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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