Iso20022

AcceptorCancellationAdviceV12

caaa.007.001.12

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
%% AcceptorCancellationAdviceV12 recursion level 0 with max 0
AcceptorCancellationAdviceV12 *-- "1..1" Header70 : Header
AcceptorCancellationAdviceV12 *-- "1..1" AcceptorCancellationAdvice12 : CancellationAdvice
AcceptorCancellationAdviceV12 *-- "0..1" ContentInformationType36 : 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
%% Header70 recursion level 0 with max 1
class Header70{
    MessageFunction MessageFunction46Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header70 *-- "1..1" GenericIdentification176 : InitiatingParty
Header70 *-- "0..1" GenericIdentification177 : RecipientParty
Header70 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification

Header70 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction46Code - 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. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification177 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability8 - 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
%% AcceptorCancellationAdvice12 recursion level 0 with max 1
AcceptorCancellationAdvice12 *-- "1..1" CardPaymentEnvironment79 : Environment
AcceptorCancellationAdvice12 *-- "0..1" CardPaymentContext30 : Context
AcceptorCancellationAdvice12 *-- "1..1" CardPaymentTransaction116 : Transaction
%% CardPaymentEnvironment79 recursion level 1 with max 1
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : ServiceProvider
CardPaymentEnvironment79 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment79 *-- "0..1" PointOfInteraction13 : POI
CardPaymentEnvironment79 *-- "0..1" PaymentCard33 : Card
CardPaymentEnvironment79 *-- "0..1" Check1 : Check
CardPaymentEnvironment79 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment79 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment79 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment79 *-- "0..1" MerchantToken2 : MerchantToken
CardPaymentEnvironment79 *-- "0..1" Cardholder20 : Cardholder
CardPaymentEnvironment79 *-- "0..1" ContentInformationType35 : ProtectedCardholderData
CardPaymentEnvironment79 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext30 recursion level 1 with max 1
CardPaymentContext30 *-- "0..1" PaymentContext29 : PaymentContext
CardPaymentContext30 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext30 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% CardPaymentTransaction116 recursion level 1 with max 1
class CardPaymentTransaction116{
    MerchantCategoryCode IsoMin3Max4Text
    CustomerConsent IsoTrueFalseIndicator
    CardProgrammeProposed IsoMax35Text
    CardProgrammeApplied IsoMax35Text
    SaleReferenceIdentification IsoMax35Text
    TransactionSuccess IsoTrueFalseIndicator
    Reversal IsoTrueFalseIndicator
    FailureReason FailureReason3Code
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax140Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax140Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction116 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction116 *-- "0..1" CardPaymentTransaction122 : OriginalTransaction
CardPaymentTransaction116 *-- "1..1" CardPaymentTransactionDetails50 : TransactionDetails
CardPaymentTransaction116 *-- "0..1" AuthorisationResult19 : AuthorisationResult

AcceptorCancellationAdvice12 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment79 - Required 1..1
Context Context in which the transaction is performed (payment and sale). CardPaymentContext30 - Optional 0..1
Transaction Cancellation transaction between an acceptor and an acquirer. CardPaymentTransaction116 - 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
%% ContentInformationType36 recursion level 0 with max 1
class ContentInformationType36{
    ContentType ContentType2Code
}
ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType36 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). AuthenticatedData9 - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the AcceptorCancellationAdviceV12 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationAdviceV12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationAdviceV12Document implements IOuterDocument. Because AcceptorCancellationAdviceV12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationAdviceV12.

classDiagram
    class IOuterRecord
    AcceptorCancellationAdviceV12 --|> IOuterRecord : Implements
    AcceptorCancellationAdviceV12Document --|> IOuterDocument~AcceptorCancellationAdviceV12~ : Implements
    class IOuterDocument~AcceptorCancellationAdviceV12~ {
        AcceptorCancellationAdviceV12 Message
     }

Document wrapper for serialization

The only real purpose AcceptorCancellationAdviceV12Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.007.001.12’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCancellationAdviceV12.ToDocument() method. The returned AcceptorCancellationAdviceV12Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    AcceptorCancellationAdviceV12Document *-- AcceptorCancellationAdviceV12 : 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.12">
    <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="_MOSQsXMQEe2vXY6MoVq19w"
  previousVersion="_fursEU1FEeybj420QgWBkA"
  name="AcceptorCancellationAdviceV12"
  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="_uZD3QJVOEeO6Q83g-JIX_w"
  xmlTag="AccptrCxlAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_MOSQs3MQEe2vXY6MoVq19w"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_MOSQtXMQEe2vXY6MoVq19w"
    previousVersion="_fursFU1FEeybj420QgWBkA"
    name="Header"
    definition="Cancellation advice message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_15eK4XJLEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_MOSQt3MQEe2vXY6MoVq19w"
    previousVersion="_fursF01FEeybj420QgWBkA"
    name="CancellationAdvice"
    definition="Information related to the cancellation advice."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlAdvc"
    complexType="_cOqc8XJ0Ee299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_MOSQuXMQEe2vXY6MoVq19w"
    previousVersion="_fursGU1FEeybj420QgWBkA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="007"
    flavour="001"
    version="12" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.