Iso20022

AcceptorCompletionAdviceResponseV08

caaa.004.001.08

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
%% AcceptorCompletionAdviceResponseV08 recursion level 0 with max 0
AcceptorCompletionAdviceResponseV08 *-- "1..1" Header58 : Header
AcceptorCompletionAdviceResponseV08 *-- "1..1" AcceptorCompletionAdviceResponse8 : CompletionAdviceResponse
AcceptorCompletionAdviceResponseV08 *-- "0..1" ContentInformationType24 : 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
%% Header58 recursion level 0 with max 1
class Header58{
    MessageFunction MessageFunction41Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header58 *-- "1..1" GenericIdentification176 : InitiatingParty
Header58 *-- "0..1" GenericIdentification177 : RecipientParty
Header58 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification

Header58 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction41Code - 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
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. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification177 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability8 - 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
%% AcceptorCompletionAdviceResponse8 recursion level 0 with max 1
AcceptorCompletionAdviceResponse8 *-- "1..1" CardPaymentEnvironment74 : Environment
AcceptorCompletionAdviceResponse8 *-- "1..1" CardPaymentTransactionAdviceResponse7 : Transaction
AcceptorCompletionAdviceResponse8 *-- "0..1" TMSTrigger1 : TMSTrigger
AcceptorCompletionAdviceResponse8 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment74 recursion level 1 with max 1
CardPaymentEnvironment74 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment74 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment74 *-- "0..1" PointOfInteraction10 : POI
CardPaymentEnvironment74 *-- "0..1" PaymentCard30 : Card
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment74 *-- "0..1" CardPaymentToken5 : PaymentToken
CardPaymentEnvironment74 *-- "0..1" Cardholder16 : Cardholder
CardPaymentEnvironment74 *-- "0..1" ContentInformationType22 : ProtectedCardholderData
%% CardPaymentTransactionAdviceResponse7 recursion level 1 with max 1
class CardPaymentTransactionAdviceResponse7{
    SaleReferenceIdentification IsoMax35Text
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax140Text
    ReconciliationIdentification IsoMax35Text
    Response Response4Code
}
CardPaymentTransactionAdviceResponse7 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
    TMSContactLevel TMSContactLevel1Code
    TMSIdentification IsoMax35Text
    TMSContactDateTime IsoISODateTime
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorCompletionAdviceResponse8 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment74 - Required 1..1
Transaction Card payment transaction between an acceptor and an acquirer. CardPaymentTransactionAdviceResponse7 - Required 1..1
TMSTrigger Instructions for contacting the terminal management host. TMSTrigger1 - Optional 0..1
SupplementaryData Additional information incorporated as an extension to the message. SupplementaryData1 - Unknown 0..0

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
%% ContentInformationType24 recursion level 0 with max 1
class ContentInformationType24{
    ContentType ContentType2Code
}
ContentInformationType24 *-- "1..1" AuthenticatedData6 : AuthenticatedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType24 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). AuthenticatedData6 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceResponseV08 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceResponseV08Document --|> IOuterDocument~AcceptorCompletionAdviceResponseV08~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceResponseV08~ {
        AcceptorCompletionAdviceResponseV08 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceResponseV08Document *-- AcceptorCompletionAdviceResponseV08 : 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.08">
    <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="_46JYoQudEeqw5uEXxQ9H4g"
  nextVersions="_2z6m0S1yEeuZtpnZJ4v-5Q"
  previousVersion="_ULdRgdnHEeeN3v2fup_Shw"
  name="AcceptorCompletionAdviceResponseV08"
  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="_46JYowudEeqw5uEXxQ9H4g"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_46JYpQudEeqw5uEXxQ9H4g"
    nextVersions="_2z6m1S1yEeuZtpnZJ4v-5Q"
    previousVersion="_ULdRhdnHEeeN3v2fup_Shw"
    name="Header"
    definition="Completion advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_-_R68QuJEeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_46JYpwudEeqw5uEXxQ9H4g"
    nextVersions="_2z6m1y1yEeuZtpnZJ4v-5Q"
    previousVersion="_ULdRh9nHEeeN3v2fup_Shw"
    name="CompletionAdviceResponse"
    definition="Information related to the completion advice response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvcRspn"
    complexType="_rXIfkQudEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_46JYqQudEeqw5uEXxQ9H4g"
    nextVersions="_2z6m2S1yEeuZtpnZJ4v-5Q"
    previousVersion="_ULdRidnHEeeN3v2fup_Shw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_GpvT8QuEEeqYM5yH99IYQw" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="004"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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