Iso20022

AcceptorCompletionAdviceResponseV01

caaa.004.001.01

Scope The AcceptorCompletionAdviceResponse message is sent by the acquirer to acknowledge the proper receipt of an AcceptorCompletionAdvice. The message can be sent directly to the card acceptor or through an agent. Usage The AcceptorCompletionAdviceResponse message is used to acknowledge the data capture process performed by the acquirer based on the data required to carry out the financial clearing and settlement of the 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
%% AcceptorCompletionAdviceResponseV01 recursion level 0 with max 0
AcceptorCompletionAdviceResponseV01 *-- "1..1" Header2 : Header
AcceptorCompletionAdviceResponseV01 *-- "1..1" AcceptorCompletionAdviceResponse1 : CompletionAdviceResponse
AcceptorCompletionAdviceResponseV01 *-- "1..1" ContentInformationType3 : 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
%% Header2 recursion level 0 with max 1
class Header2{
    MessageFunction MessageFunction1Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header2 *-- "1..1" GenericIdentification32 : InitiatingParty
Header2 *-- "0..1" GenericIdentification32 : RecipientParty
Header2 *-- "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

Header2 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
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
%% AcceptorCompletionAdviceResponse1 recursion level 0 with max 1
AcceptorCompletionAdviceResponse1 *-- "1..1" CardPaymentEnvironment3 : Environment
AcceptorCompletionAdviceResponse1 *-- "1..1" CardPaymentTransactionAdviceResponse1 : Transaction
AcceptorCompletionAdviceResponse1 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment3 recursion level 1 with max 1
CardPaymentEnvironment3 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment3 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment3 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment3 *-- "0..1" ContentInformationType1 : ProtectedCardData
CardPaymentEnvironment3 *-- "0..1" PlainCardData3 : PlainCardData
%% CardPaymentTransactionAdviceResponse1 recursion level 1 with max 1
class CardPaymentTransactionAdviceResponse1{
    Response Response1Code
}
CardPaymentTransactionAdviceResponse1 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
    TMSContactLevel TMSContactLevel1Code
    TMSIdentification IsoMax35Text
    TMSContactDateTime IsoISODateTime
}

AcceptorCompletionAdviceResponse1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment3 - Required 1..1
Transaction Card payment transaction between an acceptor and an acquirer. CardPaymentTransactionAdviceResponse1 - 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
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
    ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent

ContentInformationType3 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). AuthenticatedData1 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceResponseV01 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceResponseV01Document --|> IOuterDocument~AcceptorCompletionAdviceResponseV01~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceResponseV01~ {
        AcceptorCompletionAdviceResponseV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceResponseV01Document *-- AcceptorCompletionAdviceResponseV01 : 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.01">
    <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="_X7-iNaMVEeCJ6YNENx4h-w_1511843266"
  nextVersions="_YqRw4QvgEeK9Xewg3qiFQA"
  name="AcceptorCompletionAdviceResponseV01"
  definition="Scope&#xD;&#xA;The AcceptorCompletionAdviceResponse message is sent by the acquirer to acknowledge the proper receipt of an AcceptorCompletionAdvice. The message can be sent directly to the card acceptor or through an agent.&#xD;&#xA;Usage&#xD;&#xA;The AcceptorCompletionAdviceResponse message is used to acknowledge the data capture process performed by the acquirer based on the data required to carry out the financial clearing and settlement of the transaction."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCmpltnAdvcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_X7-iNqMVEeCJ6YNENx4h-w_-827371409"
    name="Header"
    definition="Completion advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SwPX2gEcEeCQm6a_G2yO_w_-2124028495" />
  <messageBuildingBlock
    xmi:id="_X7-iN6MVEeCJ6YNENx4h-w_-1291534155"
    name="CompletionAdviceResponse"
    definition="Information related to the completion advice response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvcRspn"
    complexType="_Svo67AEcEeCQm6a_G2yO_w_-1950407895" />
  <messageBuildingBlock
    xmi:id="_X7-iOKMVEeCJ6YNENx4h-w_-2123909944"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="004"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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