caaa.007.001.01
Scope The AcceptorCancellationAdvice message is sent by a card acceptor to notify the cancellation of a successfully completed card payment transaction. The message can be sent directly to the acquirer or through an agent. Usage The AcceptorCancellationAdvice message is sent by the card acceptor to an acquirer when the acquirer did not receive a correct response to the AcceptorCompletionAdvice 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
%% AcceptorCancellationAdviceV01 recursion level 0 with max 0
AcceptorCancellationAdviceV01 *-- "1..1" Header2 : Header
AcceptorCancellationAdviceV01 *-- "1..1" AcceptorCancellationAdvice1 : CancellationAdvice
AcceptorCancellationAdviceV01 *-- "1..1" ContentInformationType3 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation advice message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header2 recursion level 0 with max 1
class Header2{
MessageFunction MessageFunction1Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header2 *-- "1..1" GenericIdentification32 : InitiatingParty
Header2 *-- "0..1" GenericIdentification32 : RecipientParty
Header2 *-- "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
Header2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction1Code - 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 |
| 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. | 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 |
CancellationAdvice building block
Information related to the cancellation advice. Cancellation transaction between an acceptor and an acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCancellationAdvice1 recursion level 0 with max 1
AcceptorCancellationAdvice1 *-- "1..1" CardPaymentEnvironment2 : Environment
AcceptorCancellationAdvice1 *-- "0..1" CardPaymentContext2 : Context
AcceptorCancellationAdvice1 *-- "1..1" CardPaymentTransaction7 : Transaction
%% CardPaymentEnvironment2 recursion level 1 with max 1
CardPaymentEnvironment2 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment2 *-- "0..1" Organisation5 : Merchant
CardPaymentEnvironment2 *-- "1..1" PointOfInteraction1 : POI
CardPaymentEnvironment2 *-- "1..1" PaymentCard3 : Card
CardPaymentEnvironment2 *-- "0..1" Cardholder2 : Cardholder
%% CardPaymentContext2 recursion level 1 with max 1
CardPaymentContext2 *-- "1..1" PaymentContext2 : PaymentContext
CardPaymentContext2 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction7 recursion level 1 with max 1
class CardPaymentTransaction7{
TransactionCapture IsoTrueFalseIndicator
MerchantCategoryCode IsoMin3Max4Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
FailureReason FailureReason1Code
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction7 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction7 *-- "0..1" CardPaymentTransaction8 : OriginalTransaction
CardPaymentTransaction7 *-- "1..1" CardPaymentTransactionDetails7 : TransactionDetails
CardPaymentTransaction7 *-- "0..1" AuthorisationResult2 : AuthorisationResult
AcceptorCancellationAdvice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment2 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext2 - Optional 0..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction7 - 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
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
ContentInformationType3 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). | AuthenticatedData1 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCancellationAdviceV01 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationAdviceV01Document implements IOuterDocument. Because AcceptorCancellationAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationAdviceV01.
classDiagram
class IOuterRecord
AcceptorCancellationAdviceV01 --|> IOuterRecord : Implements
AcceptorCancellationAdviceV01Document --|> IOuterDocument~AcceptorCancellationAdviceV01~ : Implements
class IOuterDocument~AcceptorCancellationAdviceV01~ {
AcceptorCancellationAdviceV01 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.007.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationAdviceV01.ToDocument() method. The returned AcceptorCancellationAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationAdviceV01Document *-- AcceptorCancellationAdviceV01 : 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.007.001.01">
<AccptrCxlAdvc>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlAdvc>
<!-- CancellationAdvice inner content -->
</CxlAdvc>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCxlAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_dGVuRaMVEeCJ6YNENx4h-w_-1804997012"
nextVersions="_TwglkQvgEeK9Xewg3qiFQA"
name="AcceptorCancellationAdviceV01"
definition="Scope
The AcceptorCancellationAdvice message is sent by a card acceptor to notify the cancellation of a successfully completed card payment transaction. The message can be sent directly to the acquirer or through an agent.
Usage
The AcceptorCancellationAdvice message is sent by the card acceptor to an acquirer when the acquirer did not receive a correct response to the AcceptorCompletionAdvice message."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_dGffQKMVEeCJ6YNENx4h-w_1875096659"
name="Header"
definition="Cancellation advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SwPX2gEcEeCQm6a_G2yO_w_-2124028495" />
<messageBuildingBlock
xmi:id="_dGffQaMVEeCJ6YNENx4h-w_2120079647"
name="CancellationAdvice"
definition="Information related to the cancellation advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlAdvc"
complexType="_Sv8c4AEcEeCQm6a_G2yO_w_238981867" />
<messageBuildingBlock
xmi:id="_dGffQqMVEeCJ6YNENx4h-w_-1140931739"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="007"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.