cain.020.001.02
The Amendment message can be initiated by any party and received by any party (acquirer, agent or issuer).
This message is used to inform the originator that the original message has been corrected/amended and then forwarded to the destination on behalf of the originator. It contains a copy of the original message and any errors found. It may also contain any corrections and/or amendments that were made to the original 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
%% AmendmentV02 recursion level 0 with max 0
AmendmentV02 *-- "1..1" Header65 : Header
AmendmentV02 *-- "1..1" Amendment11 : Body
AmendmentV02 *-- "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 an amendment message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header65 recursion level 0 with max 1
class Header65{
MessageFunction MessageFunction27Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header65 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header65 *-- "1..1" GenericIdentification183 : InitiatingParty
Header65 *-- "0..1" GenericIdentification183 : RecipientParty
Header65 *-- "0..0" AdditionalData1 : TraceData
Header65 *-- "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
Header65 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction27Code - 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
Information related to the Amendment message. Information related to the Amendment message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Amendment11 recursion level 0 with max 1
Amendment11 *-- "1..1" Environment3 : Environment
Amendment11 *-- "0..1" Context17 : Context
Amendment11 *-- "1..1" Transaction102 : Transaction
Amendment11 *-- "0..0" ProtectedData1 : ProtectedData
Amendment11 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment3 recursion level 1 with max 1
Environment3 *-- "0..1" PartyIdentification197 : Originator
Environment3 *-- "0..1" PartyIdentification197 : Sender
Environment3 *-- "0..1" PartyIdentification197 : Receiver
Environment3 *-- "0..1" PartyIdentification197 : Destination
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction102 recursion level 1 with max 1
class Transaction102{
OriginalMessage IsoMax100KBinary
MessageAmended IsoMax100KBinary
}
Transaction102 *-- "1..0" DetailedError1 : AmendedData
Transaction102 *-- "1..1" TransactionIdentification10 : TransactionIdentification
Transaction102 *-- "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
Amendment11 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Contains or describes the information pertaining to the actors interacting with the transaction. | Environment3 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context17 - Optional 0..1 |
| Transaction | Transaction details of the amendment message. | Transaction102 - 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 AmendmentV02 implementation follows a specific implementaiton pattern. First of all, AmendmentV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AmendmentV02Document implements IOuterDocument. Because AmendmentV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AmendmentV02.
classDiagram
class IOuterRecord
AmendmentV02 --|> IOuterRecord : Implements
AmendmentV02Document --|> IOuterDocument~AmendmentV02~ : Implements
class IOuterDocument~AmendmentV02~ {
AmendmentV02 Message
}
Document wrapper for serialization
The only real purpose AmendmentV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.020.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AmendmentV02.ToDocument() method. The returned AmendmentV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AmendmentV02Document *-- AmendmentV02 : 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.020.001.02">
<Amdmnt>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</Amdmnt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5FbJsRykEeyVgKPonV4SjQ"
previousVersion="_V-l6VVW1EeeiG_nL4vgKnQ"
name="AmendmentV02"
definition="The Amendment message can be initiated by any party and received by any party (acquirer, agent or issuer). 

This message is used to inform the originator that the original message has been corrected/amended and then forwarded to the destination on behalf of the originator. It contains a copy of the original message and any errors found. It may also contain any corrections and/or amendments that were made to the original message.
"
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="Amdmnt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_5FbwwRykEeyVgKPonV4SjQ"
previousVersion="_V-l6WVW1EeeiG_nL4vgKnQ"
name="Header"
definition="Information related to the management of the protocol."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_PgRJoRymEeyVgKPonV4SjQ" />
<messageBuildingBlock
xmi:id="_5FbwwxykEeyVgKPonV4SjQ"
previousVersion="_m_ub4FW8EeeiG_nL4vgKnQ"
name="Body"
definition="Information related to the Amendment message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_tOKj4ShBEeyhZIgCcGlTyA" />
<messageBuildingBlock
xmi:id="_5FbwxRykEeyVgKPonV4SjQ"
previousVersion="_V-l6V1W1EeeiG_nL4vgKnQ"
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="020"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.