cain.025.001.01
The AddendumInitiation message is sent by an acquirer or an agent to an issuer 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.
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
%% AddendumInitiationV01 recursion level 0 with max 0
AddendumInitiationV01 *-- "1..1" Header48 : Header
AddendumInitiationV01 *-- "0..1" AddendumInitiation1 : Body
AddendumInitiationV01 *-- "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
| 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. | GenericIdentification172 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification172 - 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. ISO 8583:93/2003 bit 59 | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability7 - 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
%% AddendumInitiation1 recursion level 0 with max 1
AddendumInitiation1 *-- "1..1" Environment16 : Environment
AddendumInitiation1 *-- "0..1" Context8 : Context
AddendumInitiation1 *-- "1..1" Transaction91 : Transaction
AddendumInitiation1 *-- "1..1" AddendumData1 : AddendumData
AddendumInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
AddendumInitiation1 *-- "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
%% Transaction91 recursion level 1 with max 1
class Transaction91{
AssociatedDataReference IsoMax70Text
DataSource IsoMax70Text
TransactionDescription IsoMax1000Text
}
Transaction91 *-- "1..1" TransactionIdentification14 : TransactionIdentification
Transaction91 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction91 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData1 recursion level 1 with max 1
class AddendumData1{
PurchaseIdentifierType PurchaseIdentifierType1Code
OtherPurchaseIdentifierType IsoMax35Text
PurchaseIdentifier IsoMax99Text
}
AddendumData1 *-- "0..1" AdditionalAcceptorData1 : AdditionalAcceptorData
AddendumData1 *-- "0..1" Customer4 : Customer
AddendumData1 *-- "0..1" Sale1 : Sale
AddendumData1 *-- "0..1" FleetData2 : Fleet
AddendumData1 *-- "0..1" Invoice1 : Invoice
AddendumData1 *-- "0..1" TravelAgency2 : TravelAgency
AddendumData1 *-- "0..1" PassengerTransport1 : PassengerTransport
AddendumData1 *-- "0..0" VehicleRentalService1 : VehicleRental
AddendumData1 *-- "0..0" Lodging2 : Lodging
AddendumData1 *-- "0..1" ShippingData1 : ShippingData
AddendumData1 *-- "0..1" TelecomServices1 : TelecommunicationServices
AddendumData1 *-- "0..0" TemporaryServices1 : TemporaryServices
AddendumData1 *-- "0..1" Instalment3 : Instalment
AddendumData1 *-- "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
AddendumInitiation1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Contains or describes the information pertaining to the actors interacting with the transaction. | Environment16 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context8 - Optional 0..1 |
| Transaction | Card transaction for which an authorisation is requested. | Transaction91 - Required 1..1 |
| AddendumData | Component contains data structures applicable to certain industries that require specific data within transaction messages. | AddendumData1 - 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 AddendumInitiationV01 implementation follows a specific implementaiton pattern. First of all, AddendumInitiationV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AddendumInitiationV01Document implements IOuterDocument. Because AddendumInitiationV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AddendumInitiationV01.
classDiagram
class IOuterRecord
AddendumInitiationV01 --|> IOuterRecord : Implements
AddendumInitiationV01Document --|> IOuterDocument~AddendumInitiationV01~ : Implements
class IOuterDocument~AddendumInitiationV01~ {
AddendumInitiationV01 Message
}
Document wrapper for serialization
The only real purpose AddendumInitiationV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.025.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AddendumInitiationV01.ToDocument() method. The returned AddendumInitiationV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AddendumInitiationV01Document *-- AddendumInitiationV01 : 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.01">
<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="_RHEuodkcEeizh_fAW7LywQ"
nextVersions="_FqDuYYdJEeuBS50MFjViNw"
name="AddendumInitiationV01"
definition="The AddendumInitiation message is sent by an acquirer or an agent to an issuer 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="Registered"
messageSet="_oFVkcKmaEeqA4rV5xCgycA"
xmlTag="AdddmInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_RHF8wdkcEeizh_fAW7LywQ"
nextVersions="_FqDuY4dJEeuBS50MFjViNw"
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="_61gpsNkeEeizh_fAW7LywQ"
nextVersions="_FqDuZYdJEeuBS50MFjViNw"
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="_EOI42vJAEeiJn9rM2Znz2w" />
<messageBuildingBlock
xmi:id="_RHF8xdkcEeizh_fAW7LywQ"
nextVersions="_FqDuZ4dJEeuBS50MFjViNw"
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="025"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.