caaa.008.001.05
The AcceptorCancellationAdviceResponse message is sent by the acquirer (or its agent) to acknowledge the acceptor (or its agent) about the notification of the payment cancellation.
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
%% AcceptorCancellationAdviceResponseV05 recursion level 0 with max 0
AcceptorCancellationAdviceResponseV05 *-- "1..1" Header24 : Header
AcceptorCancellationAdviceResponseV05 *-- "1..1" AcceptorCancellationAdviceResponse5 : CancellationAdviceResponse
AcceptorCancellationAdviceResponseV05 *-- "0..1" ContentInformationType15 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation advice response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header24 recursion level 0 with max 1
class Header24{
MessageFunction MessageFunction10Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header24 *-- "1..1" GenericIdentification53 : InitiatingParty
Header24 *-- "0..1" GenericIdentification94 : RecipientParty
Header24 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification
Header24 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction10Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoNumber - Required 1..1 |
| ReTransmissionCounter | Number of retransmissions of the message. | IsoMax3NumericText - Optional 0..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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification94 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability5 - Unknown 0..0 |
CancellationAdviceResponse building block
Information related to the cancellation advice response. Cancellation advice response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCancellationAdviceResponse5 recursion level 0 with max 1
AcceptorCancellationAdviceResponse5 *-- "1..1" CardPaymentEnvironment46 : Environment
AcceptorCancellationAdviceResponse5 *-- "1..1" CardPaymentTransactionAdviceResponse6 : Transaction
AcceptorCancellationAdviceResponse5 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment46 recursion level 1 with max 1
CardPaymentEnvironment46 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment46 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment46 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment46 *-- "0..1" PaymentCard19 : Card
CardPaymentEnvironment46 *-- "0..1" CardPaymentToken2 : PaymentToken
%% CardPaymentTransactionAdviceResponse6 recursion level 1 with max 1
class CardPaymentTransactionAdviceResponse6{
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
Response Response4Code
}
CardPaymentTransactionAdviceResponse6 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
TMSContactLevel TMSContactLevel1Code
TMSIdentification IsoMax35Text
TMSContactDateTime IsoISODateTime
}
AcceptorCancellationAdviceResponse5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment46 - Required 1..1 |
| Transaction | Cancellation transaction from an acceptor to the acquirer. | CardPaymentTransactionAdviceResponse6 - Required 1..1 |
| TMSTrigger | Instructions for contacting the terminal management host. | TMSTrigger1 - Optional 0..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
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType15 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationAdviceResponseV05 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationAdviceResponseV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationAdviceResponseV05Document implements IOuterDocument. Because AcceptorCancellationAdviceResponseV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationAdviceResponseV05.
classDiagram
class IOuterRecord
AcceptorCancellationAdviceResponseV05 --|> IOuterRecord : Implements
AcceptorCancellationAdviceResponseV05Document --|> IOuterDocument~AcceptorCancellationAdviceResponseV05~ : Implements
class IOuterDocument~AcceptorCancellationAdviceResponseV05~ {
AcceptorCancellationAdviceResponseV05 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationAdviceResponseV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.008.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationAdviceResponseV05.ToDocument() method. The returned AcceptorCancellationAdviceResponseV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationAdviceResponseV05Document *-- AcceptorCancellationAdviceResponseV05 : 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.008.001.05">
<AccptrCxlAdvcRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlAdvcRspn>
<!-- CancellationAdviceResponse inner content -->
</CxlAdvcRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCxlAdvcRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_L2kbQY1HEeWsypzzYao74A"
nextVersions="_w7YG8ap5EeanIZ10Ka8PnA"
previousVersion="_oHt6AWl-EeSxgrJ0GX4SQQ"
name="AcceptorCancellationAdviceResponseV05"
definition="The AcceptorCancellationAdviceResponse message is sent by the acquirer (or its agent) to acknowledge the acceptor (or its agent) about the notification of the payment cancellation."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlAdvcRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_L2kbQ41HEeWsypzzYao74A"
type="purpose" />
<messageBuildingBlock
xmi:id="_L2kbRY1HEeWsypzzYao74A"
nextVersions="_w7YG9ap5EeanIZ10Ka8PnA"
previousVersion="_oHt6BWl-EeSxgrJ0GX4SQQ"
name="Header"
definition="Cancellation advice response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UwmNcY07EeWPUZwhUA4U-w" />
<messageBuildingBlock
xmi:id="_L2kbR41HEeWsypzzYao74A"
nextVersions="_w7YG96p5EeanIZ10Ka8PnA"
previousVersion="_oHt6B2l-EeSxgrJ0GX4SQQ"
name="CancellationAdviceResponse"
definition="Information related to the cancellation advice response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlAdvcRspn"
complexType="_XP0ygY1HEeWsypzzYao74A" />
<messageBuildingBlock
xmi:id="_L2kbSY1HEeWsypzzYao74A"
nextVersions="_w7YG-ap5EeanIZ10Ka8PnA"
previousVersion="_oHt6CWl-EeSxgrJ0GX4SQQ"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="008"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.