ReversalInitiationV03

cain.005.001.03

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
%% ReversalInitiationV03 recursion level 0 with max 0
ReversalInitiationV03 *-- "1..1" Header62 : Header
ReversalInitiationV03 *-- "1..1" ReversalInitiation2 : Body
ReversalInitiationV03 *-- "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 reversal of an authorisation or financial message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReversalInitiation2 recursion level 0 with max 1
class ReversalInitiation2{
    ICCRelatedData IsoMax10KHexBinaryText
}
ReversalInitiation2 *-- "1..1" Environment19 : Environment
ReversalInitiation2 *-- "0..1" Context14 : Context
ReversalInitiation2 *-- "1..1" Transaction142 : Transaction
ReversalInitiation2 *-- "0..1" ProcessingResult16 : ProcessingResult
ReversalInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
ReversalInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment19 recursion level 1 with max 1
Environment19 *-- "1..1" PartyIdentification263 : Acquirer
Environment19 *-- "0..1" PartyIdentification263 : Originator
Environment19 *-- "0..1" PartyIdentification263 : Sender
Environment19 *-- "0..1" PartyIdentification263 : Receiver
Environment19 *-- "0..1" PartyIdentification253 : Acceptor
Environment19 *-- "0..1" PartyIdentification263 : Destination
Environment19 *-- "0..1" PartyIdentification257 : Payer
Environment19 *-- "0..1" PartyIdentification257 : Payee
Environment19 *-- "0..1" Terminal6 : Terminal
Environment19 *-- "0..1" PartyIdentification263 : Issuer
Environment19 *-- "1..1" CardData10 : Card
Environment19 *-- "0..1" Wallet2 : Wallet
Environment19 *-- "0..1" Token2 : Token
%% Context14 recursion level 1 with max 1
Context14 *-- "0..1" PointOfServiceContext5 : PointOfServiceContext
Context14 *-- "0..1" TransactionContext9 : TransactionContext
%% Transaction142 recursion level 1 with max 1
class Transaction142{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute2Code
    OtherTransactionAttribute IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    PreAuthorisationTimeLimit IsoMax6NumericText
    AssociatedDataIndicator IsoTrueFalseIndicator
    AssociatedDataReference IsoMax70Text
    AssociatedDataDestination IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction142 *-- "0..0" AdditionalService2 : AdditionalService
Transaction142 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction142 *-- "1..1" TransactionIdentification51 : TransactionIdentification
Transaction142 *-- "0..0" DisputeData3 : DisputeData
Transaction142 *-- "1..1" TransactionAmounts2 : TransactionAmounts
Transaction142 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction142 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction142 *-- "0..0" AdditionalFee2 : OriginalAdditionalFee
Transaction142 *-- "0..0" DepositDetails2 : DepositDetails
Transaction142 *-- "0..1" FundingService2 : FundsServices
Transaction142 *-- "0..1" AccountDetails3 : AccountFrom
Transaction142 *-- "0..1" AccountDetails3 : AccountTo
Transaction142 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult16 recursion level 1 with max 1
class ProcessingResult16{
    ApprovalCode IsoExact6AlphaNumericText
    ActionRequired IsoYesNoIndicator
}
ProcessingResult16 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult16 *-- "0..1" ResultData7 : ResultData
ProcessingResult16 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult16 *-- "0..0" Action13 : Action
ProcessingResult16 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult16 *-- "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
  

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

classDiagram
    class IOuterRecord
    ReversalInitiationV03 --|> IOuterRecord : Implements
    ReversalInitiationV03Document --|> IOuterDocument~ReversalInitiationV03~ : Implements
    class IOuterDocument~ReversalInitiationV03~ {
        ReversalInitiationV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ReversalInitiationV03Document *-- ReversalInitiationV03 : 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.03">
    <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="_U0x9oYHOEeuwq_rv81SdXw"
  previousVersion="_ctEcNVT_EeetiruPyDPo0Q"
  name="ReversalInitiationV03"
  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="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="RvslInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_U0yksYHOEeuwq_rv81SdXw"
    previousVersion="_ctEcNlT_EeetiruPyDPo0Q"
    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="_U0yks4HOEeuwq_rv81SdXw"
    previousVersion="_ctEcOVT_EeetiruPyDPo0Q"
    name="Body"
    definition="Information related to the reversal of an authorisation or financial transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_LKK5gYHOEeuwq_rv81SdXw" />
  <messageBuildingBlock
    xmi:id="_U0yktYHOEeuwq_rv81SdXw"
    previousVersion="_ctEcN1T_EeetiruPyDPo0Q"
    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="03" />
</messageDefinition>

ISO Building Blocks

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