Iso20022

AcceptorCompletionAdviceResponseV04

caaa.004.001.04

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
%% AcceptorCompletionAdviceResponseV04 recursion level 0 with max 0
AcceptorCompletionAdviceResponseV04 *-- "1..1" Header11 : Header
AcceptorCompletionAdviceResponseV04 *-- "1..1" AcceptorCompletionAdviceResponse4 : CompletionAdviceResponse
AcceptorCompletionAdviceResponseV04 *-- "1..1" ContentInformationType11 : 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
%% Header11 recursion level 0 with max 1
class Header11{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header11 *-- "1..1" GenericIdentification53 : InitiatingParty
Header11 *-- "0..1" GenericIdentification53 : RecipientParty
Header11 *-- "0..0" Traceability2 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% Traceability2 recursion level 1 with max 1
class Traceability2{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification

Header11 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. GenericIdentification53 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification53 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability2 - 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
%% AcceptorCompletionAdviceResponse4 recursion level 0 with max 1
AcceptorCompletionAdviceResponse4 *-- "1..1" CardPaymentEnvironment33 : Environment
AcceptorCompletionAdviceResponse4 *-- "1..1" CardPaymentTransactionAdviceResponse4 : Transaction
AcceptorCompletionAdviceResponse4 *-- "0..1" TMSTrigger1 : TMSTrigger
AcceptorCompletionAdviceResponse4 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment33 recursion level 1 with max 1
CardPaymentEnvironment33 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment33 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment33 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment33 *-- "0..1" PaymentCard10 : Card
CardPaymentEnvironment33 *-- "0..1" CardPaymentToken2 : PaymentToken
%% 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
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorCompletionAdviceResponse4 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment33 - 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
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
%% ContentInformationType11 recursion level 0 with max 1
class ContentInformationType11{
    ContentType ContentType2Code
}
ContentInformationType11 *-- "0..0" 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

ContentInformationType11 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 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceResponseV04 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceResponseV04Document --|> IOuterDocument~AcceptorCompletionAdviceResponseV04~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceResponseV04~ {
        AcceptorCompletionAdviceResponseV04 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceResponseV04Document *-- AcceptorCompletionAdviceResponseV04 : 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.04">
    <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="_26bowWlwEeSGkpGpjm7tzg"
  nextVersions="_wjV0QY0-EeWPUZwhUA4U-w"
  previousVersion="_5XIYkTJMEeOkpIB9tKITlw"
  name="AcceptorCompletionAdviceResponseV04"
  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="_26bow2lwEeSGkpGpjm7tzg"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_26boxWlwEeSGkpGpjm7tzg"
    nextVersions="_wjV0RY0-EeWPUZwhUA4U-w"
    previousVersion="_5XIYkzJMEeOkpIB9tKITlw"
    name="Header"
    definition="Completion advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_df0eUWlqEeSGkpGpjm7tzg" />
  <messageBuildingBlock
    xmi:id="_26box2lwEeSGkpGpjm7tzg"
    nextVersions="_wjV0R40-EeWPUZwhUA4U-w"
    previousVersion="_5XIYlTJMEeOkpIB9tKITlw"
    name="CompletionAdviceResponse"
    definition="Information related to the completion advice response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvcRspn"
    complexType="_8IXtQWlwEeSGkpGpjm7tzg" />
  <messageBuildingBlock
    xmi:id="_26boyWlwEeSGkpGpjm7tzg"
    nextVersions="_wjV0SY0-EeWPUZwhUA4U-w"
    previousVersion="_5XIYlzJMEeOkpIB9tKITlw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_cg4dYWkIEeS7zPBpvm732w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="004"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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