Iso20022

AcceptorCancellationRequestV04

caaa.005.001.04

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
%% AcceptorCancellationRequestV04 recursion level 0 with max 0
AcceptorCancellationRequestV04 *-- "1..1" Header10 : Header
AcceptorCancellationRequestV04 *-- "1..1" AcceptorCancellationRequest4 : CancellationRequest
AcceptorCancellationRequestV04 *-- "1..1" ContentInformationType11 : 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
%% Header10 recursion level 0 with max 1
class Header10{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header10 *-- "1..1" GenericIdentification53 : InitiatingParty
Header10 *-- "0..1" GenericIdentification53 : RecipientParty
Header10 *-- "0..0" Traceability2 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% Traceability2 recursion level 1 with max 1
class Traceability2{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification

Header10 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
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. GenericIdentification53 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability2 - 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
%% AcceptorCancellationRequest4 recursion level 0 with max 1
AcceptorCancellationRequest4 *-- "1..1" CardPaymentEnvironment35 : Environment
AcceptorCancellationRequest4 *-- "1..1" CardPaymentContext10 : Context
AcceptorCancellationRequest4 *-- "1..1" CardPaymentTransaction41 : Transaction
%% CardPaymentEnvironment35 recursion level 1 with max 1
CardPaymentEnvironment35 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment35 *-- "0..1" Organisation8 : Merchant
CardPaymentEnvironment35 *-- "1..1" PointOfInteraction4 : POI
CardPaymentEnvironment35 *-- "1..1" PaymentCard11 : Card
CardPaymentEnvironment35 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment35 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment35 *-- "0..1" CardPaymentToken3 : PaymentToken
%% CardPaymentContext10 recursion level 1 with max 1
CardPaymentContext10 *-- "1..1" PaymentContext10 : PaymentContext
CardPaymentContext10 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction41 recursion level 1 with max 1
class CardPaymentTransaction41{
    TransactionCapture IsoTrueFalseIndicator
    MerchantCategoryCode IsoMin3Max4Text
    SaleReferenceIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction41 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction41 *-- "1..1" CardPaymentTransaction37 : OriginalTransaction
CardPaymentTransaction41 *-- "1..1" CardPaymentTransactionDetails5 : TransactionDetails

AcceptorCancellationRequest4 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment35 - Required 1..1
Context Context in which the transaction is performed (payment and sale). CardPaymentContext10 - Required 1..1
Transaction Cancellation transaction between an acceptor and an acquirer. CardPaymentTransaction41 - 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
%% ContentInformationType11 recursion level 0 with max 1
class ContentInformationType11{
    ContentType ContentType2Code
}
ContentInformationType11 *-- "0..0" 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

ContentInformationType11 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 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCancellationRequestV04 --|> IOuterRecord : Implements
    AcceptorCancellationRequestV04Document --|> IOuterDocument~AcceptorCancellationRequestV04~ : Implements
    class IOuterDocument~AcceptorCancellationRequestV04~ {
        AcceptorCancellationRequestV04 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCancellationRequestV04Document *-- AcceptorCancellationRequestV04 : 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.04">
    <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="_rI7scGl3EeSQMKir9owD5A"
  nextVersions="_bq6h8Y1AEeWsypzzYao74A"
  previousVersion="_O1urUTJREeO58eY-wGOnqw"
  name="AcceptorCancellationRequestV04"
  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">
  <doclet
    xmi:id="_rI7scml3EeSQMKir9owD5A"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_rI7sdGl3EeSQMKir9owD5A"
    nextVersions="_bq6h9Y1AEeWsypzzYao74A"
    previousVersion="_O1urUzJREeO58eY-wGOnqw"
    name="Header"
    definition="Cancellation request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
  <messageBuildingBlock
    xmi:id="_rI7sdml3EeSQMKir9owD5A"
    nextVersions="_bq6h941AEeWsypzzYao74A"
    previousVersion="_O1urVTJREeO58eY-wGOnqw"
    name="CancellationRequest"
    definition="Information related to the cancellation request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlReq"
    complexType="_0goboWl3EeSQMKir9owD5A" />
  <messageBuildingBlock
    xmi:id="_rI7seGl3EeSQMKir9owD5A"
    nextVersions="_bq6h-Y1AEeWsypzzYao74A"
    previousVersion="_O1urVzJREeO58eY-wGOnqw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_cg4dYWkIEeS7zPBpvm732w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="005"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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