Iso20022

AcceptorCompletionAdviceResponseV03

caaa.004.001.03

The AcceptorCompletionAdviceResponse message is sent by the acquirer (or its agent) to acknowledge the acceptor (or its agent) of the outcome of the payment transaction, and the transfer the financial data of the transaction contained in the completion advice.

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
%% AcceptorCompletionAdviceResponseV03 recursion level 0 with max 0
AcceptorCompletionAdviceResponseV03 *-- "1..1" Header8 : Header
AcceptorCompletionAdviceResponseV03 *-- "1..1" AcceptorCompletionAdviceResponse3 : CompletionAdviceResponse
AcceptorCompletionAdviceResponseV03 *-- "1..1" ContentInformationType8 : SecurityTrailer

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

Header building block

Completion advice response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

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

Header8 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
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. 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

CompletionAdviceResponse building block

Information related to the completion advice response. Acknowledgement by the acquirer, of the completion advice of the card payment at the acceptor. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorCompletionAdviceResponse3 recursion level 0 with max 1
AcceptorCompletionAdviceResponse3 *-- "1..1" CardPaymentEnvironment21 : Environment
AcceptorCompletionAdviceResponse3 *-- "1..1" CardPaymentTransactionAdviceResponse4 : Transaction
AcceptorCompletionAdviceResponse3 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment21 recursion level 1 with max 1
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment21 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment21 *-- "0..1" ContentInformationType7 : ProtectedCardData
CardPaymentEnvironment21 *-- "0..1" PlainCardData5 : PlainCardData
%% CardPaymentTransactionAdviceResponse4 recursion level 1 with max 1
class CardPaymentTransactionAdviceResponse4{
    SaleReferenceIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    Response Response1Code
}
CardPaymentTransactionAdviceResponse4 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
    TMSContactLevel TMSContactLevel1Code
    TMSIdentification IsoMax35Text
    TMSContactDateTime IsoISODateTime
}

AcceptorCompletionAdviceResponse3 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment21 - Required 1..1
Transaction Card payment transaction between an acceptor and an acquirer. CardPaymentTransactionAdviceResponse4 - Required 1..1
TMSTrigger Instructions for contacting the terminal management host. TMSTrigger1 - Optional 0..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
%% ContentInformationType8 recursion level 0 with max 1
class ContentInformationType8{
    ContentType ContentType1Code
}
ContentInformationType8 *-- "0..0" AuthenticatedData3 : AuthenticatedData
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent

ContentInformationType8 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). AuthenticatedData3 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceResponseV03 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceResponseV03Document --|> IOuterDocument~AcceptorCompletionAdviceResponseV03~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceResponseV03~ {
        AcceptorCompletionAdviceResponseV03 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceResponseV03Document *-- AcceptorCompletionAdviceResponseV03 : 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.004.001.03">
    <AccptrCmpltnAdvcRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CmpltnAdvcRspn>
            <!-- CompletionAdviceResponse inner content -->
        </CmpltnAdvcRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCmpltnAdvcRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_5XIYkTJMEeOkpIB9tKITlw"
  nextVersions="_26bowWlwEeSGkpGpjm7tzg"
  previousVersion="_YqRw4QvgEeK9Xewg3qiFQA"
  name="AcceptorCompletionAdviceResponseV03"
  definition="The AcceptorCompletionAdviceResponse message is sent by the acquirer (or its agent) to acknowledge the acceptor (or its agent) of the outcome of the payment transaction, and the transfer the financial data of the transaction contained in the completion advice."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCmpltnAdvcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_5iSfsDJMEeOkpIB9tKITlw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_5XIYkzJMEeOkpIB9tKITlw"
    nextVersions="_26boxWlwEeSGkpGpjm7tzg"
    previousVersion="_YqRw4wvgEeK9Xewg3qiFQA"
    name="Header"
    definition="Completion advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_ykPy8TGxEeOH78pE3LSlGw" />
  <messageBuildingBlock
    xmi:id="_5XIYlTJMEeOkpIB9tKITlw"
    nextVersions="_26box2lwEeSGkpGpjm7tzg"
    previousVersion="_YqRw5wvgEeK9Xewg3qiFQA"
    name="CompletionAdviceResponse"
    definition="Information related to the completion advice response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvcRspn"
    complexType="_TmmLkTJMEeOkpIB9tKITlw" />
  <messageBuildingBlock
    xmi:id="_5XIYlzJMEeOkpIB9tKITlw"
    nextVersions="_26boyWlwEeSGkpGpjm7tzg"
    previousVersion="_YqRw6wvgEeK9Xewg3qiFQA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_KpedcTF5EeO118ZQJgaQSQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="004"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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