caaa.007.001.05
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
%% AcceptorCancellationAdviceV05 recursion level 0 with max 0
AcceptorCancellationAdviceV05 *-- "1..1" Header24 : Header
AcceptorCancellationAdviceV05 *-- "1..1" AcceptorCancellationAdvice5 : CancellationAdvice
AcceptorCancellationAdviceV05 *-- "0..1" ContentInformationType15 : 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
%% 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 |
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
%% AcceptorCancellationAdvice5 recursion level 0 with max 1
AcceptorCancellationAdvice5 *-- "1..1" CardPaymentEnvironment49 : Environment
AcceptorCancellationAdvice5 *-- "0..1" CardPaymentContext17 : Context
AcceptorCancellationAdvice5 *-- "1..1" CardPaymentTransaction59 : Transaction
%% CardPaymentEnvironment49 recursion level 1 with max 1
CardPaymentEnvironment49 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment49 *-- "0..1" Organisation25 : Merchant
CardPaymentEnvironment49 *-- "1..1" PointOfInteraction5 : POI
CardPaymentEnvironment49 *-- "1..1" PaymentCard20 : Card
CardPaymentEnvironment49 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment49 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment49 *-- "0..1" CardPaymentToken3 : PaymentToken
%% CardPaymentContext17 recursion level 1 with max 1
CardPaymentContext17 *-- "1..1" PaymentContext17 : PaymentContext
CardPaymentContext17 *-- "0..1" SaleContext2 : SaleContext
%% CardPaymentTransaction59 recursion level 1 with max 1
class CardPaymentTransaction59{
MerchantCategoryCode IsoMin3Max4Text
SaleReferenceIdentification IsoMax35Text
TransactionSuccess IsoTrueFalseIndicator
Reversal IsoTrueFalseIndicator
FailureReason FailureReason3Code
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction59 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction59 *-- "0..1" CardPaymentTransaction52 : OriginalTransaction
CardPaymentTransaction59 *-- "1..1" CardPaymentTransactionDetails34 : TransactionDetails
CardPaymentTransaction59 *-- "0..1" AuthorisationResult11 : AuthorisationResult
AcceptorCancellationAdvice5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment49 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext17 - Optional 0..1 |
| Transaction | Cancellation transaction between an acceptor and an acquirer. | CardPaymentTransaction59 - 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
%% 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 AcceptorCancellationAdviceV05 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationAdviceV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationAdviceV05Document implements IOuterDocument. Because AcceptorCancellationAdviceV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationAdviceV05.
classDiagram
class IOuterRecord
AcceptorCancellationAdviceV05 --|> IOuterRecord : Implements
AcceptorCancellationAdviceV05Document --|> IOuterDocument~AcceptorCancellationAdviceV05~ : Implements
class IOuterDocument~AcceptorCancellationAdviceV05~ {
AcceptorCancellationAdviceV05 Message
}
Document wrapper for serialization
The only real purpose AcceptorCancellationAdviceV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.007.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationAdviceV05.ToDocument() method. The returned AcceptorCancellationAdviceV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCancellationAdviceV05Document *-- AcceptorCancellationAdviceV05 : 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.05">
<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="_mVdm0Y1FEeWsypzzYao74A"
nextVersions="_P6yMIap_EeanIZ10Ka8PnA"
previousVersion="_UhKcEWl8EeSxgrJ0GX4SQQ"
name="AcceptorCancellationAdviceV05"
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="_mVdm041FEeWsypzzYao74A"
type="purpose" />
<messageBuildingBlock
xmi:id="_mVdm1Y1FEeWsypzzYao74A"
nextVersions="_P6yMJap_EeanIZ10Ka8PnA"
previousVersion="_UhKcFWl8EeSxgrJ0GX4SQQ"
name="Header"
definition="Cancellation advice message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UwmNcY07EeWPUZwhUA4U-w" />
<messageBuildingBlock
xmi:id="_mVdm141FEeWsypzzYao74A"
nextVersions="_P6yMJ6p_EeanIZ10Ka8PnA"
previousVersion="_UhKcF2l8EeSxgrJ0GX4SQQ"
name="CancellationAdvice"
definition="Information related to the cancellation advice."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CxlAdvc"
complexType="_12mZcY1FEeWsypzzYao74A" />
<messageBuildingBlock
xmi:id="_mVdm2Y1FEeWsypzzYao74A"
nextVersions="_P6yMKap_EeanIZ10Ka8PnA"
previousVersion="_UhKcGWl8EeSxgrJ0GX4SQQ"
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="007"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.