cain.025.001.02
Provides supplemental data in addition to that which is required to complete an authorization initiation or financial initiation.
The supplemental data is associated with an authorization or financial 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
%% AddendumInitiationV02 recursion level 0 with max 0
AddendumInitiationV02 *-- "1..1" Header66 : Header
AddendumInitiationV02 *-- "0..1" AddendumInitiation2 : Body
AddendumInitiationV02 *-- "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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction29Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax2048Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange of messages between two parties. | IsoMax35Text - Optional 0..1 |
| ReTransmissionCounter | Number of retransmission of the message. Incremented by one for each retransmission. | IsoMax3NumericText - Optional 0..1 |
| CreationDateTime | Date and time at which the message was sent. | IsoISODateTime - Required 1..1 |
| BatchManagementInformation | Information related to the batch and the collection to which the message belongs if any. | BatchManagementInformation1 - Optional 0..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification183 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification183 - Optional 0..1 |
| TraceData | Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability9 - Unknown 0..0 |
Body building block
The AddendumInitiation is used to provide supplemental data in addition to that which is required to complete an authorization initiation or financial initiation. The supplemental data is associated with an authorization or financial message. 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
%% AddendumInitiation2 recursion level 0 with max 1
AddendumInitiation2 *-- "1..1" Environment30 : Environment
AddendumInitiation2 *-- "0..1" Context17 : Context
AddendumInitiation2 *-- "1..1" Transaction148 : Transaction
AddendumInitiation2 *-- "1..1" AddendumData3 : AddendumData
AddendumInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
AddendumInitiation2 *-- "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
%% Transaction148 recursion level 1 with max 1
class Transaction148{
AssociatedDataReference IsoMax70Text
DataSource IsoMax70Text
TransactionDescription IsoMax1000Text
}
Transaction148 *-- "1..1" TransactionIdentification20 : TransactionIdentification
Transaction148 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction148 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData3 recursion level 1 with max 1
class AddendumData3{
PurchaseIdentifierType PurchaseIdentifierType1Code
OtherPurchaseIdentifierType IsoMax35Text
PurchaseIdentifier IsoMax99Text
}
AddendumData3 *-- "0..1" AdditionalAcceptorData1 : AdditionalAcceptorData
AddendumData3 *-- "0..1" Customer4 : Customer
AddendumData3 *-- "0..1" Sale2 : Sale
AddendumData3 *-- "0..1" FleetData4 : Fleet
AddendumData3 *-- "0..1" Invoice2 : Invoice
AddendumData3 *-- "0..0" TravelAgency3 : TravelAgency
AddendumData3 *-- "0..1" PassengerTransport2 : PassengerTransport
AddendumData3 *-- "0..0" VehicleRentalService2 : VehicleRental
AddendumData3 *-- "0..0" Lodging3 : Lodging
AddendumData3 *-- "0..1" ShippingData2 : ShippingData
AddendumData3 *-- "0..1" TelecomServices2 : TelecommunicationServices
AddendumData3 *-- "0..0" TemporaryServices2 : TemporaryServices
AddendumData3 *-- "0..1" Instalment4 : Instalment
AddendumData3 *-- "0..0" AdditionalData1 : AdditionalData
%% 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
AddendumInitiation2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Contains or describes the information pertaining to the actors interacting with the transaction. | Environment30 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context17 - Optional 0..1 |
| Transaction | Card transaction for which an authorisation is requested. | Transaction148 - Required 1..1 |
| AddendumData | Component contains data structures applicable to certain industries that require specific data within transaction messages. | AddendumData3 - Required 1..1 |
| ProtectedData | Contains protected data and the attributes used to protect the data. | ProtectedData1 - Unknown 0..0 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or other specific block. | SupplementaryData1 - Unknown 0..0 |
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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MACData | Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 | MACData1 - Required 1..1 |
| MAC | Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 | IsoMax8HexBinaryText - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AddendumInitiationV02 implementation follows a specific implementaiton pattern. First of all, AddendumInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AddendumInitiationV02Document implements IOuterDocument. Because AddendumInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AddendumInitiationV02.
classDiagram
class IOuterRecord
AddendumInitiationV02 --|> IOuterRecord : Implements
AddendumInitiationV02Document --|> IOuterDocument~AddendumInitiationV02~ : Implements
class IOuterDocument~AddendumInitiationV02~ {
AddendumInitiationV02 Message
}
Document wrapper for serialization
The only real purpose AddendumInitiationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.025.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AddendumInitiationV02.ToDocument() method. The returned AddendumInitiationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AddendumInitiationV02Document *-- AddendumInitiationV02 : 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.025.001.02">
<AdddmInitn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AdddmInitn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_FqDuYYdJEeuBS50MFjViNw"
previousVersion="_RHEuodkcEeizh_fAW7LywQ"
name="AddendumInitiationV02"
definition="Provides supplemental data in addition to that which is required to complete an authorization initiation or financial initiation. 

The supplemental data is associated with an authorization or financial message."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="AdddmInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_FqDuY4dJEeuBS50MFjViNw"
previousVersion="_RHF8wdkcEeizh_fAW7LywQ"
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="_FqDuZYdJEeuBS50MFjViNw"
previousVersion="_61gpsNkeEeizh_fAW7LywQ"
name="Body"
definition="The AddendumInitiation is used to provide supplemental data in addition to that which is required to complete an authorization initiation or financial initiation. The supplemental data is associated with an authorization or financial message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="Body"
complexType="_RtF34YdIEeuBS50MFjViNw" />
<messageBuildingBlock
xmi:id="_FqDuZ4dJEeuBS50MFjViNw"
previousVersion="_RHF8xdkcEeizh_fAW7LywQ"
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="025"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.