Iso20022

AcceptorCancellationResponseV05

caaa.006.001.05

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
%% AcceptorCancellationResponseV05 recursion level 0 with max 0
AcceptorCancellationResponseV05 *-- "1..1" Header30 : Header
AcceptorCancellationResponseV05 *-- "1..1" AcceptorCancellationResponse5 : CancellationResponse
AcceptorCancellationResponseV05 *-- "0..1" ContentInformationType15 : 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
%% Header30 recursion level 0 with max 1
class Header30{
    MessageFunction MessageFunction10Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header30 *-- "1..1" GenericIdentification53 : InitiatingParty
Header30 *-- "0..1" GenericIdentification94 : RecipientParty
Header30 *-- "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

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

CancellationResponse building block

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

classDiagram
   direction tb
%% AcceptorCancellationResponse5 recursion level 0 with max 1
AcceptorCancellationResponse5 *-- "1..1" CardPaymentEnvironment46 : Environment
AcceptorCancellationResponse5 *-- "1..1" CardPaymentTransaction57 : Transaction
AcceptorCancellationResponse5 *-- "1..1" CardPaymentTransaction58 : TransactionResponse
%% CardPaymentEnvironment46 recursion level 1 with max 1
CardPaymentEnvironment46 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment46 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment46 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment46 *-- "0..1" PaymentCard19 : Card
CardPaymentEnvironment46 *-- "0..1" CardPaymentToken2 : PaymentToken
%% CardPaymentTransaction57 recursion level 1 with max 1
class CardPaymentTransaction57{
    SaleReferenceIdentification IsoMax35Text
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax140Text
}
CardPaymentTransaction57 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction57 *-- "1..1" CardPaymentTransactionDetails35 : TransactionDetails
%% CardPaymentTransaction58 recursion level 1 with max 1
CardPaymentTransaction58 *-- "1..1" AuthorisationResult12 : AuthorisationResult
CardPaymentTransaction58 *-- "0..0" Action6 : Action

AcceptorCancellationResponse5 members

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

classDiagram
    class IOuterRecord
    AcceptorCancellationResponseV05 --|> IOuterRecord : Implements
    AcceptorCancellationResponseV05Document --|> IOuterDocument~AcceptorCancellationResponseV05~ : Implements
    class IOuterDocument~AcceptorCancellationResponseV05~ {
        AcceptorCancellationResponseV05 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCancellationResponseV05Document *-- AcceptorCancellationResponseV05 : 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.05">
    <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="_7WKrYY1DEeWsypzzYao74A"
  nextVersions="_FsTYMap6EeanIZ10Ka8PnA"
  previousVersion="_mPa4cWl6EeSQMKir9owD5A"
  name="AcceptorCancellationResponseV05"
  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">
  <doclet
    xmi:id="_7WKrY41DEeWsypzzYao74A"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_7WKrZY1DEeWsypzzYao74A"
    nextVersions="_FsTYNap6EeanIZ10Ka8PnA"
    previousVersion="_mPa4dWl6EeSQMKir9owD5A"
    name="Header"
    definition="Cancellation response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_IWFRgY0PEeWRYffwL7E13A" />
  <messageBuildingBlock
    xmi:id="_7WKrZ41DEeWsypzzYao74A"
    nextVersions="_FsTYN6p6EeanIZ10Ka8PnA"
    previousVersion="_mPa4d2l6EeSQMKir9owD5A"
    name="CancellationResponse"
    definition="Information related to the cancellation response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlRspn"
    complexType="_YYGJgY1EEeWsypzzYao74A" />
  <messageBuildingBlock
    xmi:id="_7WKraY1DEeWsypzzYao74A"
    nextVersions="_FsTYOap6EeanIZ10Ka8PnA"
    previousVersion="_mPa4eWl6EeSQMKir9owD5A"
    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="006"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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