AddendumResponseV01

cain.026.001.01

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

Header48 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
%% AddendumResponse1 recursion level 0 with max 1
AddendumResponse1 *-- "1..1" Environment16 : Environment
AddendumResponse1 *-- "0..1" Context8 : Context
AddendumResponse1 *-- "1..1" Transaction92 : Transaction
AddendumResponse1 *-- "1..1" ProcessingResult4 : ProcessingResult
AddendumResponse1 *-- "0..0" ProtectedData1 : ProtectedData
AddendumResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment16 recursion level 1 with max 1
Environment16 *-- "1..1" PartyIdentification197 : Acquirer
Environment16 *-- "0..1" PartyIdentification197 : Sender
Environment16 *-- "0..1" PartyIdentification197 : Receiver
Environment16 *-- "0..1" PartyIdentification197 : Destination
Environment16 *-- "0..1" CardData2 : Card
Environment16 *-- "0..1" Token1 : Token
%% Context8 recursion level 1 with max 1
Context8 *-- "0..1" TransactionContext5 : TransactionContext
%% Transaction92 recursion level 1 with max 1
class Transaction92{
    AssociatedDataReference IsoMax70Text
    TransactionDescription IsoMax1000Text
}
Transaction92 *-- "1..1" TransactionIdentification13 : TransactionIdentification
Transaction92 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction92 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult4 recursion level 1 with max 1
ProcessingResult4 *-- "0..1" ResultData5 : ResultData
ProcessingResult4 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult4 *-- "0..0" AdditionalInformation22 : 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
  

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

classDiagram
    class IOuterRecord
    AddendumResponseV01 --|> IOuterRecord : Implements
    AddendumResponseV01Document --|> IOuterDocument~AddendumResponseV01~ : Implements
    class IOuterDocument~AddendumResponseV01~ {
        AddendumResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AddendumResponseV01Document *-- AddendumResponseV01 : 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.01">
    <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="_XWt78f5kEeiLerArw36g0w"
  nextVersions="_SgYZMYdMEeuBS50MFjViNw"
  name="AddendumResponseV01"
  definition="The AddendumResponse message is sent by an issuer or an agent to an acquirer in response to an AddendumInitiation message."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="AdddmRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_XWt78_5kEeiLerArw36g0w"
    nextVersions="_SgZAQYdMEeuBS50MFjViNw"
    previousVersion="_ow6wscsZEeizUq4cFQ71-Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_wmyN8VaGEeeFltjJxERUxw" />
  <messageBuildingBlock
    xmi:id="_XWujAf5kEeiLerArw36g0w"
    nextVersions="_SgZAQ4dMEeuBS50MFjViNw"
    previousVersion="_ow6ws8sZEeizUq4cFQ71-Q"
    name="Body"
    definition="Information related to an addendum response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_QmeFQf5mEeiLerArw36g0w" />
  <messageBuildingBlock
    xmi:id="_XWujA_5kEeiLerArw36g0w"
    nextVersions="_SgZARYdMEeuBS50MFjViNw"
    previousVersion="_ow6wtcsZEeizUq4cFQ71-Q"
    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="01" />
</messageDefinition>

ISO Building Blocks

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