Iso20022

AcceptorCancellationResponseV02

caaa.006.001.02

The AcceptorCancellationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the outcome of the cancellation request. If the response is positive, the acquirer has voided the financial data from the captured transaction.

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
%% AcceptorCancellationResponseV02 recursion level 0 with max 0
AcceptorCancellationResponseV02 *-- "1..1" Header1 : Header
AcceptorCancellationResponseV02 *-- "1..1" AcceptorCancellationResponse2 : CancellationResponse
AcceptorCancellationResponseV02 *-- "1..1" ContentInformationType6 : SecurityTrailer

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

Header building block

Cancellation response 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

CancellationResponse building block

Information related to the cancellation response. Cancellation response from the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorCancellationResponse2 recursion level 0 with max 1
AcceptorCancellationResponse2 *-- "1..1" CardPaymentEnvironment11 : Environment
AcceptorCancellationResponse2 *-- "1..1" CardPaymentTransaction6 : Transaction
AcceptorCancellationResponse2 *-- "1..1" CardPaymentTransaction10 : TransactionResponse
%% CardPaymentEnvironment11 recursion level 1 with max 1
CardPaymentEnvironment11 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment11 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment11 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment11 *-- "0..1" ContentInformationType5 : ProtectedCardData
CardPaymentEnvironment11 *-- "0..1" PlainCardData3 : PlainCardData
%% CardPaymentTransaction6 recursion level 1 with max 1
class CardPaymentTransaction6{
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax35Text
}
CardPaymentTransaction6 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction6 *-- "1..1" CardPaymentTransactionDetails6 : TransactionDetails
%% CardPaymentTransaction10 recursion level 1 with max 1
CardPaymentTransaction10 *-- "1..1" AuthorisationResult1 : AuthorisationResult
CardPaymentTransaction10 *-- "0..0" Action1 : Action

AcceptorCancellationResponse2 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment11 - Required 1..1
Transaction Cancellation transaction between an acceptor and an acquirer. CardPaymentTransaction6 - Required 1..1
TransactionResponse Response from the acquirer to the cancellation transaction. CardPaymentTransaction10 - 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 AcceptorCancellationResponseV02 implementation follows a specific implementaiton pattern. First of all, AcceptorCancellationResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCancellationResponseV02Document implements IOuterDocument. Because AcceptorCancellationResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCancellationResponseV02.

classDiagram
    class IOuterRecord
    AcceptorCancellationResponseV02 --|> IOuterRecord : Implements
    AcceptorCancellationResponseV02Document --|> IOuterDocument~AcceptorCancellationResponseV02~ : Implements
    class IOuterDocument~AcceptorCancellationResponseV02~ {
        AcceptorCancellationResponseV02 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCancellationResponseV02Document *-- AcceptorCancellationResponseV02 : 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.006.001.02">
    <AccptrCxlRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CxlRspn>
            <!-- CancellationResponse inner content -->
        </CxlRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCxlRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_KKYY0QvgEeK9Xewg3qiFQA"
  nextVersions="_i0LIATJXEeO58eY-wGOnqw"
  previousVersion="_bXUntaMVEeCJ6YNENx4h-w_-227867844"
  name="AcceptorCancellationResponseV02"
  definition="The AcceptorCancellationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the outcome of the cancellation request. If the response is positive, the acquirer has voided the financial data from the captured transaction."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCxlRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_KKYY0wvgEeK9Xewg3qiFQA"
    nextVersions="_i0LIAzJXEeO58eY-wGOnqw"
    name="Header"
    definition="Cancellation response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
  <messageBuildingBlock
    xmi:id="_KKYY1wvgEeK9Xewg3qiFQA"
    nextVersions="_i0LIBTJXEeO58eY-wGOnqw"
    name="CancellationResponse"
    definition="Information related to the cancellation response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlRspn"
    complexType="_5EY3UQvWEeKzJ69IWwzB9Q" />
  <messageBuildingBlock
    xmi:id="_KKYY2wvgEeK9Xewg3qiFQA"
    nextVersions="_i0LIBzJXEeO58eY-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="006"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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