caaa.006.001.03
The AcceptorCancellationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the outcome of the cancellation request. If the response is positive, the acquirer has voided the financial data from the captured transaction.
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
%% AcceptorCancellationResponseV03 recursion level 0 with max 0
AcceptorCancellationResponseV03 *-- "1..1" Header7 : Header
AcceptorCancellationResponseV03 *-- "1..1" AcceptorCancellationResponse3 : CancellationResponse
AcceptorCancellationResponseV03 *-- "1..1" ContentInformationType8 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header7 recursion level 0 with max 1
class Header7{
MessageFunction MessageFunction4Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header7 *-- "1..1" GenericIdentification32 : InitiatingParty
Header7 *-- "0..1" GenericIdentification32 : RecipientParty
Header7 *-- "0..0" Traceability1 : Traceability
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% Traceability1 recursion level 1 with max 1
class Traceability1{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability1 *-- "1..1" GenericIdentification31 : RelayIdentification
Header7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction4Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification32 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification32 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability1 - Unknown 0..0 |
CancellationResponse building block
Information related to the cancellation response. Cancellation response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCancellationResponse3 recursion level 0 with max 1
AcceptorCancellationResponse3 *-- "1..1" CardPaymentEnvironment21 : Environment
AcceptorCancellationResponse3 *-- "1..1" CardPaymentTransaction35 : Transaction
AcceptorCancellationResponse3 *-- "1..1" CardPaymentTransaction27 : TransactionResponse
%% CardPaymentEnvironment21 recursion level 1 with max 1
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment21 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment21 *-- "0..1" ContentInformationType7 : ProtectedCardData
CardPaymentEnvironment21 *-- "0..1" PlainCardData5 : PlainCardData
%% CardPaymentTransaction35 recursion level 1 with max 1
class CardPaymentTransaction35{
SaleReferenceIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax35Text
}
CardPaymentTransaction35 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction35 *-- "1..1" CardPaymentTransactionDetails6 : TransactionDetails
%% CardPaymentTransaction27 recursion level 1 with max 1
CardPaymentTransaction27 *-- "1..1" AuthorisationResult3 : AuthorisationResult
CardPaymentTransaction27 *-- "0..0" Action1 : Action
AcceptorCancellationResponse3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment21 - Required 1..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction35 - Required 1..1 |
| TransactionResponse | Response from the acquirer to the cancellation transaction. | CardPaymentTransaction27 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType8 recursion level 0 with max 1
class ContentInformationType8{
ContentType ContentType1Code
}
ContentInformationType8 *-- "0..0" AuthenticatedData3 : AuthenticatedData
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
ContentInformationType8 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType1Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData3 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationResponseV03 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationResponseV03Document implements IOuterDocument. Because AcceptorCancellationResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationResponseV03.
classDiagram
class IOuterRecord
AcceptorCancellationResponseV03 --|> IOuterRecord : Implements
AcceptorCancellationResponseV03Document --|> IOuterDocument~AcceptorCancellationResponseV03~ : Implements
class IOuterDocument~AcceptorCancellationResponseV03~ {
AcceptorCancellationResponseV03 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationResponseV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.006.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationResponseV03.ToDocument() method. The returned AcceptorCancellationResponseV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationResponseV03Document *-- AcceptorCancellationResponseV03 : 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:caaa.006.001.03">
<AccptrCxlRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlRspn>
<!-- CancellationResponse inner content -->
</CxlRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCxlRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_i0LIATJXEeO58eY-wGOnqw"
nextVersions="_mPa4cWl6EeSQMKir9owD5A"
previousVersion="_KKYY0QvgEeK9Xewg3qiFQA"
name="AcceptorCancellationResponseV03"
definition="The AcceptorCancellationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the outcome of the cancellation request. If the response is positive, the acquirer has voided the financial data from the captured transaction."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_i_LeIDJXEeO58eY-wGOnqw"
type="purpose" />
<messageBuildingBlock
xmi:id="_i0LIAzJXEeO58eY-wGOnqw"
nextVersions="_mPa4dWl6EeSQMKir9owD5A"
previousVersion="_KKYY0wvgEeK9Xewg3qiFQA"
name="Header"
definition="Cancellation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UNSh8S9IEeOlZIh7PImd0A" />
<messageBuildingBlock
xmi:id="_i0LIBTJXEeO58eY-wGOnqw"
nextVersions="_mPa4d2l6EeSQMKir9owD5A"
previousVersion="_KKYY1wvgEeK9Xewg3qiFQA"
name="CancellationResponse"
definition="Information related to the cancellation response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlRspn"
complexType="_UQGakTJXEeO58eY-wGOnqw" />
<messageBuildingBlock
xmi:id="_i0LIBzJXEeO58eY-wGOnqw"
nextVersions="_mPa4eWl6EeSQMKir9owD5A"
previousVersion="_KKYY2wvgEeK9Xewg3qiFQA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_KpedcTF5EeO118ZQJgaQSQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="006"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.