Iso20022

AcceptorCancellationRequestV02

caaa.005.001.02

The AcceptorCancellationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to request the cancellation of a successfully completed transaction. Cancellation should only occur before the transaction has been cleared.

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
%% AcceptorCancellationRequestV02 recursion level 0 with max 0
AcceptorCancellationRequestV02 *-- "1..1" Header1 : Header
AcceptorCancellationRequestV02 *-- "1..1" AcceptorCancellationRequest2 : CancellationRequest
AcceptorCancellationRequestV02 *-- "1..1" ContentInformationType6 : SecurityTrailer

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Cancellation request message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header1 recursion level 0 with max 1
class Header1{
    MessageFunction MessageFunction1Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header1 *-- "1..1" GenericIdentification32 : InitiatingParty
Header1 *-- "0..1" GenericIdentification32 : RecipientParty
Header1 *-- "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

Header1 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
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

CancellationRequest building block

Information related to the cancellation request. Cancellation request from an acceptor. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorCancellationRequest2 recursion level 0 with max 1
AcceptorCancellationRequest2 *-- "1..1" CardPaymentEnvironment12 : Environment
AcceptorCancellationRequest2 *-- "1..1" CardPaymentContext1 : Context
AcceptorCancellationRequest2 *-- "1..1" CardPaymentTransaction15 : Transaction
%% CardPaymentEnvironment12 recursion level 1 with max 1
CardPaymentEnvironment12 *-- "0..1" Acquirer2 : Acquirer
CardPaymentEnvironment12 *-- "0..1" Organisation8 : Merchant
CardPaymentEnvironment12 *-- "1..1" PointOfInteraction2 : POI
CardPaymentEnvironment12 *-- "1..1" PaymentCard6 : Card
%% CardPaymentContext1 recursion level 1 with max 1
CardPaymentContext1 *-- "1..1" PaymentContext1 : PaymentContext
CardPaymentContext1 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction15 recursion level 1 with max 1
class CardPaymentTransaction15{
    TransactionCapture IsoTrueFalseIndicator
    MerchantCategoryCode IsoMin3Max4Text
    ReconciliationIdentification IsoMax35Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction15 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction15 *-- "1..1" CardPaymentTransaction17 : OriginalTransaction
CardPaymentTransaction15 *-- "1..1" CardPaymentTransactionDetails5 : TransactionDetails

AcceptorCancellationRequest2 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment12 - Required 1..1
Context Context in which the transaction is performed (payment and sale). CardPaymentContext1 - Required 1..1
Transaction Cancellation transaction between an acceptor and an acquirer. CardPaymentTransaction15 - 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
%% ContentInformationType6 recursion level 0 with max 1
class ContentInformationType6{
    ContentType ContentType1Code
}
ContentInformationType6 *-- "0..0" AuthenticatedData2 : AuthenticatedData
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent

ContentInformationType6 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). AuthenticatedData2 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCancellationRequestV02 --|> IOuterRecord : Implements
    AcceptorCancellationRequestV02Document --|> IOuterDocument~AcceptorCancellationRequestV02~ : Implements
    class IOuterDocument~AcceptorCancellationRequestV02~ {
        AcceptorCancellationRequestV02 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCancellationRequestV02Document *-- AcceptorCancellationRequestV02 : 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.005.001.02">
    <AccptrCxlReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CxlReq>
            <!-- CancellationRequest inner content -->
        </CxlReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_D8tVoQvgEeK9Xewg3qiFQA"
  nextVersions="_O1urUTJREeO58eY-wGOnqw"
  previousVersion="_cMhxZaMVEeCJ6YNENx4h-w_602094635"
  name="AcceptorCancellationRequestV02"
  definition="The AcceptorCancellationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to request the cancellation of a successfully completed transaction. Cancellation should only occur before the transaction has been cleared.&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCxlReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_D8tVowvgEeK9Xewg3qiFQA"
    nextVersions="_O1urUzJREeO58eY-wGOnqw"
    name="Header"
    definition="Cancellation request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
  <messageBuildingBlock
    xmi:id="_D8tVpwvgEeK9Xewg3qiFQA"
    nextVersions="_O1urVTJREeO58eY-wGOnqw"
    name="CancellationRequest"
    definition="Information related to the cancellation request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlReq"
    complexType="_j7S9sQvWEeKzJ69IWwzB9Q" />
  <messageBuildingBlock
    xmi:id="_D8tVqwvgEeK9Xewg3qiFQA"
    nextVersions="_O1urVzJREeO58eY-wGOnqw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_6DM4sQvFEeKzJ69IWwzB9Q" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="005"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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