caaa.007.001.03
The AcceptorCancellationAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the cancellation of a successfully completed transaction. The transaction has been completed without financial transfer, or the acceptor is aware that the transaction was not cleared by the acquirer.
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
%% AcceptorCancellationAdviceV03 recursion level 0 with max 0
AcceptorCancellationAdviceV03 *-- "1..1" Header8 : Header
AcceptorCancellationAdviceV03 *-- "1..1" AcceptorCancellationAdvice3 : CancellationAdvice
AcceptorCancellationAdviceV03 *-- "1..1" ContentInformationType8 : 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
%% Header8 recursion level 0 with max 1
class Header8{
MessageFunction MessageFunction4Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header8 *-- "1..1" GenericIdentification32 : InitiatingParty
Header8 *-- "0..1" GenericIdentification32 : RecipientParty
Header8 *-- "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
Header8 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 |
| 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
%% AcceptorCancellationAdvice3 recursion level 0 with max 1
AcceptorCancellationAdvice3 *-- "1..1" CardPaymentEnvironment24 : Environment
AcceptorCancellationAdvice3 *-- "0..1" CardPaymentContext2 : Context
AcceptorCancellationAdvice3 *-- "1..1" CardPaymentTransaction28 : Transaction
%% CardPaymentEnvironment24 recursion level 1 with max 1
CardPaymentEnvironment24 *-- "0..1" Acquirer2 : Acquirer
CardPaymentEnvironment24 *-- "0..1" Organisation8 : Merchant
CardPaymentEnvironment24 *-- "1..1" PointOfInteraction3 : POI
CardPaymentEnvironment24 *-- "1..1" PaymentCard8 : Card
%% CardPaymentContext2 recursion level 1 with max 1
CardPaymentContext2 *-- "1..1" PaymentContext2 : PaymentContext
CardPaymentContext2 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction28 recursion level 1 with max 1
class CardPaymentTransaction28{
MerchantCategoryCode IsoMin3Max4Text
SaleReferenceIdentification IsoMax35Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
FailureReason FailureReason3Code
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction28 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction28 *-- "0..1" CardPaymentTransaction21 : OriginalTransaction
CardPaymentTransaction28 *-- "1..1" CardPaymentTransactionDetails7 : TransactionDetails
CardPaymentTransaction28 *-- "0..1" AuthorisationResult2 : AuthorisationResult
AcceptorCancellationAdvice3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment24 - 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. | CardPaymentTransaction28 - 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 AcceptorCancellationAdviceV03 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationAdviceV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationAdviceV03Document implements IOuterDocument. Because AcceptorCancellationAdviceV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationAdviceV03.
classDiagram
class IOuterRecord
AcceptorCancellationAdviceV03 --|> IOuterRecord : Implements
AcceptorCancellationAdviceV03Document --|> IOuterDocument~AcceptorCancellationAdviceV03~ : Implements
class IOuterDocument~AcceptorCancellationAdviceV03~ {
AcceptorCancellationAdviceV03 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationAdviceV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.007.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationAdviceV03.ToDocument() method. The returned AcceptorCancellationAdviceV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationAdviceV03Document *-- AcceptorCancellationAdviceV03 : 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.03">
<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="_rxfg8TJaEeO58eY-wGOnqw"
nextVersions="_UhKcEWl8EeSxgrJ0GX4SQQ"
previousVersion="_TwglkQvgEeK9Xewg3qiFQA"
name="AcceptorCancellationAdviceV03"
definition="The AcceptorCancellationAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the cancellation of a successfully completed transaction. The transaction has been completed without financial transfer, or the acceptor is aware that the transaction was not cleared by the acquirer."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCxlAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_r89KEDJaEeO58eY-wGOnqw"
type="purpose" />
<messageBuildingBlock
xmi:id="_rxfg8zJaEeO58eY-wGOnqw"
nextVersions="_UhKcFWl8EeSxgrJ0GX4SQQ"
previousVersion="_TwglkwvgEeK9Xewg3qiFQA"
name="Header"
definition="Cancellation advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_ykPy8TGxEeOH78pE3LSlGw" />
<messageBuildingBlock
xmi:id="_rxfg9TJaEeO58eY-wGOnqw"
nextVersions="_UhKcF2l8EeSxgrJ0GX4SQQ"
previousVersion="_TwgllwvgEeK9Xewg3qiFQA"
name="CancellationAdvice"
definition="Information related to the cancellation advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlAdvc"
complexType="_nEUP4TJJEeOkpIB9tKITlw" />
<messageBuildingBlock
xmi:id="_rxfg9zJaEeO58eY-wGOnqw"
nextVersions="_UhKcGWl8EeSxgrJ0GX4SQQ"
previousVersion="_TwglmwvgEeK9Xewg3qiFQA"
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="007"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.