cain.027.001.01
The ChargeBackInitiation message is sent by an issuer or agent to an acquirer to fully or partially nullify a previous financial transaction; namely when the issuer determines that a customer dispute exists or that an error or violation of rules has been committed. It is also used to nullify a previous chargeback. Chargebacks have a financial impact and should be computed within reconciliation totals.
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
%% ChargeBackInitiationV01 recursion level 0 with max 0
ChargeBackInitiationV01 *-- "1..1" Header40 : Header
ChargeBackInitiationV01 *-- "1..1" ChargeBackInitiation1 : Body
ChargeBackInitiationV01 *-- "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 protocol management. Set of characteristics related to the protocol.
For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header40 recursion level 0 with max 1
class Header40{
MessageFunction MessageFunction20Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header40 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header40 *-- "1..1" GenericIdentification172 : InitiatingParty
Header40 *-- "0..1" GenericIdentification172 : RecipientParty
Header40 *-- "0..0" AdditionalData1 : TraceData
Header40 *-- "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
Header40 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction20Code - 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
Information related to the initiation of a chargeback. ISO 8583:93/2003 bit 25. Information related to the chargeback initiation transaction. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ChargeBackInitiation1 recursion level 0 with max 1
ChargeBackInitiation1 *-- "1..1" Environment13 : Environment
ChargeBackInitiation1 *-- "0..1" Context7 : Context
ChargeBackInitiation1 *-- "1..1" Transaction97 : Transaction
ChargeBackInitiation1 *-- "1..1" OriginalTransaction1 : OriginalTransaction
ChargeBackInitiation1 *-- "0..1" ProcessingResult8 : ProcessingResult
ChargeBackInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
ChargeBackInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment13 recursion level 1 with max 1
Environment13 *-- "1..1" PartyIdentification197 : Acquirer
Environment13 *-- "0..1" PartyIdentification197 : Sender
Environment13 *-- "0..1" PartyIdentification197 : Receiver
Environment13 *-- "0..1" PartyIdentification203 : Acceptor
Environment13 *-- "0..1" PartyIdentification211 : Payer
Environment13 *-- "0..1" PartyIdentification211 : Payee
Environment13 *-- "0..1" Terminal2 : Terminal
Environment13 *-- "1..1" CardData5 : Card
Environment13 *-- "0..1" Wallet1 : Wallet
Environment13 *-- "0..1" Token1 : Token
%% Context7 recursion level 1 with max 1
Context7 *-- "0..1" PointOfServiceContext2 : PointOfServiceContext
Context7 *-- "0..1" TransactionContext4 : TransactionContext
%% Transaction97 recursion level 1 with max 1
class Transaction97{
MessageReason IsoExact4NumericText
AlternateMessageReason IsoMax35Text
}
Transaction97 *-- "1..1" TransactionIdentification10 : TransactionIdentification
Transaction97 *-- "1..1" TransactionAmounts1 : TransactionAmounts
Transaction97 *-- "1..1" DisputeData1 : DisputeData
Transaction97 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction97 *-- "0..1" AdditionalInformation20 : AdditionalInformation
Transaction97 *-- "0..0" AdditionalData1 : AdditionalData
%% OriginalTransaction1 recursion level 1 with max 1
OriginalTransaction1 *-- "0..1" Environment6 : Environment
OriginalTransaction1 *-- "0..1" Context3 : Context
OriginalTransaction1 *-- "0..1" Transaction85 : Transaction
OriginalTransaction1 *-- "0..1" ProcessingResult2 : ProcessingResult
%% ProcessingResult8 recursion level 1 with max 1
ProcessingResult8 *-- "0..1" ResultData1 : ResultData
ProcessingResult8 *-- "0..0" AdditionalInformation20 : 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
ChargeBackInitiation1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the chargeback. | Environment13 - Required 1..1 |
| Context | Context of the chargeback transaction. | Context7 - Optional 0..1 |
| Transaction | Chargeback transaction details. | Transaction97 - Required 1..1 |
| OriginalTransaction | Contains details of the transaction to be retrieved. | OriginalTransaction1 - Required 1..1 |
| ProcessingResult | Result of the chargeback verification provided in the chargeback status. | ProcessingResult8 - Optional 0..1 |
| ProtectedData | EContains 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. It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128. 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 ChargeBackInitiationV01 implementation follows a specific implementaiton pattern. First of all, ChargeBackInitiationV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ChargeBackInitiationV01Document implements IOuterDocument. Because ChargeBackInitiationV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ChargeBackInitiationV01.
classDiagram
class IOuterRecord
ChargeBackInitiationV01 --|> IOuterRecord : Implements
ChargeBackInitiationV01Document --|> IOuterDocument~ChargeBackInitiationV01~ : Implements
class IOuterDocument~ChargeBackInitiationV01~ {
ChargeBackInitiationV01 Message
}
Document wrapper for serialization
The only real purpose ChargeBackInitiationV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.027.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ChargeBackInitiationV01.ToDocument() method. The returned ChargeBackInitiationV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ChargeBackInitiationV01Document *-- ChargeBackInitiationV01 : 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.027.001.01">
<ChrgBckInitn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ChrgBckInitn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_1HbrRFZdEeen1vB4iz5SyA"
nextVersions="_52D7IYHSEeuwq_rv81SdXw"
name="ChargeBackInitiationV01"
definition="The ChargeBackInitiation message is sent by an issuer or agent to an acquirer to fully or partially nullify a previous financial transaction; namely when the issuer determines that a customer dispute exists or that an error or violation of rules has been committed. It is also used to nullify a previous chargeback. Chargebacks have a financial impact and should be computed within reconciliation totals."
registrationStatus="Registered"
messageSet="_oFVkcKmaEeqA4rV5xCgycA"
xmlTag="ChrgBckInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_1HbrRlZdEeen1vB4iz5SyA"
nextVersions="_52D7I4HSEeuwq_rv81SdXw"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UlnWoVBOEeedyPuM0kK2EQ" />
<messageBuildingBlock
xmi:id="_1HbrR1ZdEeen1vB4iz5SyA"
nextVersions="_52D7JYHSEeuwq_rv81SdXw"
name="Body"
definition="Information related to the initiation of a chargeback.
ISO 8583:93/2003 bit 25."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_qz-mEFDZEee94_dUz-hvgw" />
<messageBuildingBlock
xmi:id="_1HbrRVZdEeen1vB4iz5SyA"
nextVersions="_52D7J4HSEeuwq_rv81SdXw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC.
It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
<messageDefinitionIdentifier
businessArea="cain"
messageFunctionality="027"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.