AddendumResponseV02

cain.026.001.02

The AddendumResponse message is sent by an issuer or an agent to an acquirer in response to an AddendumInitiation 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
%% AddendumResponseV02 recursion level 0 with max 0
AddendumResponseV02 *-- "1..1" Header66 : Header
AddendumResponseV02 *-- "1..1" AddendumResponse2 : Body
AddendumResponseV02 *-- "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. Header for a fee collection message. ISO 8583 MTI For comparison, see the ISO20022 official specification

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

Header66 members

Body building block

Information related to an addendum response. Addendum message is used in conjunction with an authorisation or financial message to provide supplemental data above that required to complete an authorisation initiation or financial initiation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AddendumResponse2 recursion level 0 with max 1
AddendumResponse2 *-- "1..1" Environment30 : Environment
AddendumResponse2 *-- "0..1" Context17 : Context
AddendumResponse2 *-- "1..1" Transaction149 : Transaction
AddendumResponse2 *-- "1..1" ProcessingResult19 : ProcessingResult
AddendumResponse2 *-- "0..0" ProtectedData1 : ProtectedData
AddendumResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment30 recursion level 1 with max 1
Environment30 *-- "1..1" PartyIdentification263 : Acquirer
Environment30 *-- "0..1" PartyIdentification263 : Originator
Environment30 *-- "0..1" PartyIdentification263 : Sender
Environment30 *-- "0..1" PartyIdentification263 : Receiver
Environment30 *-- "0..1" PartyIdentification255 : Acceptor
Environment30 *-- "0..1" PartyIdentification263 : Destination
Environment30 *-- "0..1" PartyIdentification263 : Issuer
Environment30 *-- "0..1" CardData2 : Card
Environment30 *-- "0..1" Token2 : Token
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction149 recursion level 1 with max 1
class Transaction149{
    AssociatedDataReference IsoMax70Text
    TransactionDescription IsoMax1000Text
}
Transaction149 *-- "1..1" TransactionIdentification20 : TransactionIdentification
Transaction149 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction149 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult19 recursion level 1 with max 1
ProcessingResult19 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult19 *-- "1..1" ResultData10 : ResultData
ProcessingResult19 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult19 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult19 *-- "0..0" AdditionalInformation30 : 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
  

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

classDiagram
    class IOuterRecord
    AddendumResponseV02 --|> IOuterRecord : Implements
    AddendumResponseV02Document --|> IOuterDocument~AddendumResponseV02~ : Implements
    class IOuterDocument~AddendumResponseV02~ {
        AddendumResponseV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AddendumResponseV02Document *-- AddendumResponseV02 : 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.026.001.02">
    <AdddmRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AdddmRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_SgYZMYdMEeuBS50MFjViNw"
  previousVersion="_XWt78f5kEeiLerArw36g0w"
  name="AddendumResponseV02"
  definition="The AddendumResponse message is sent by an issuer or an agent to an acquirer in response to an AddendumInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="AdddmRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_SgZAQYdMEeuBS50MFjViNw"
    previousVersion="_XWt78_5kEeiLerArw36g0w"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_aRA58RynEeyVgKPonV4SjQ" />
  <messageBuildingBlock
    xmi:id="_SgZAQ4dMEeuBS50MFjViNw"
    previousVersion="_XWujAf5kEeiLerArw36g0w"
    name="Body"
    definition="Information related to an addendum response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_HWD10YdMEeuBS50MFjViNw" />
  <messageBuildingBlock
    xmi:id="_SgZARYdMEeuBS50MFjViNw"
    previousVersion="_XWujA_5kEeiLerArw36g0w"
    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="026"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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