Iso20022

AcceptorCompletionAdviceV01

caaa.003.001.01

Scope The AcceptorCompletionAdvice message is sent by a card acceptor to notify an acquirer about the completion and final outcome of a card payment transaction. The message can be sent directly to the acquirer or through an agent. Usage The AcceptorCompletionAdvice message is used either to:

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
%% AcceptorCompletionAdviceV01 recursion level 0 with max 0
AcceptorCompletionAdviceV01 *-- "1..1" Header2 : Header
AcceptorCompletionAdviceV01 *-- "1..1" AcceptorCompletionAdvice1 : CompletionAdvice
AcceptorCompletionAdviceV01 *-- "1..1" ContentInformationType3 : SecurityTrailer

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

Header building block

Completion advice 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

CompletionAdvice building block

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

classDiagram
   direction tb
%% AcceptorCompletionAdvice1 recursion level 0 with max 1
AcceptorCompletionAdvice1 *-- "1..1" CardPaymentEnvironment2 : Environment
AcceptorCompletionAdvice1 *-- "0..1" CardPaymentContext2 : Context
AcceptorCompletionAdvice1 *-- "1..1" CardPaymentTransaction3 : Transaction
%% CardPaymentEnvironment2 recursion level 1 with max 1
CardPaymentEnvironment2 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment2 *-- "0..1" Organisation5 : Merchant
CardPaymentEnvironment2 *-- "1..1" PointOfInteraction1 : POI
CardPaymentEnvironment2 *-- "1..1" PaymentCard3 : Card
CardPaymentEnvironment2 *-- "0..1" Cardholder2 : Cardholder
%% CardPaymentContext2 recursion level 1 with max 1
CardPaymentContext2 *-- "1..1" PaymentContext2 : PaymentContext
CardPaymentContext2 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction3 recursion level 1 with max 1
class CardPaymentTransaction3{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType1Code
    AdditionalService CardPaymentServiceType2Code
    ServiceAttribute CardPaymentServiceType3Code
    MerchantCategoryCode IsoMin3Max4Text
    TransactionSuccess IsoTrueFalseIndicator
    Reversal IsoTrueFalseIndicator
    MerchantOverride IsoTrueFalseIndicator
    FailureReason FailureReason1Code
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax35Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction3 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction3 *-- "0..1" CardPaymentTransaction8 : OriginalTransaction
CardPaymentTransaction3 *-- "1..1" CardPaymentTransactionDetails3 : TransactionDetails
CardPaymentTransaction3 *-- "0..1" AuthorisationResult2 : AuthorisationResult
CardPaymentTransaction3 *-- "0..1" TransactionVerificationResult1 : TransactionVerificationResult

AcceptorCompletionAdvice1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment2 - Required 1..1
Context Context in which the transaction is performed (payment and sale). CardPaymentContext2 - Optional 0..1
Transaction Card payment transaction between an acceptor and an acquirer. CardPaymentTransaction3 - 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
%% 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 AcceptorCompletionAdviceV01 implementation follows a specific implementaiton pattern. First of all, AcceptorCompletionAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCompletionAdviceV01Document implements IOuterDocument. Because AcceptorCompletionAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCompletionAdviceV01.

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceV01 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceV01Document --|> IOuterDocument~AcceptorCompletionAdviceV01~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceV01~ {
        AcceptorCompletionAdviceV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceV01Document *-- AcceptorCompletionAdviceV01 : 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.003.001.01">
    <AccptrCmpltnAdvc>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CmpltnAdvc>
            <!-- CompletionAdvice inner content -->
        </CmpltnAdvc>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCmpltnAdvc>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_W92GBaMVEeCJ6YNENx4h-w_871403476"
  nextVersions="_zp8RwQvfEeK9Xewg3qiFQA"
  name="AcceptorCompletionAdviceV01"
  definition="Scope&#xD;&#xA;The AcceptorCompletionAdvice message is sent by a card acceptor to notify an acquirer about the completion and final outcome of a card payment transaction. The message can be sent directly to the acquirer or through an agent.&#xD;&#xA;Usage&#xD;&#xA;The AcceptorCompletionAdvice message is used either to:&#xD;&#xA;- inform the acquirer about the successful end of a transaction;&#xD;&#xA;- reverse a transaction which was not successfully completed (for example, cancellation of transaction by the cardholder), but where an authorisation had been previously given.&#xD;&#xA;The AcceptorCompletionAdvice message may also embed the information required for transferring to the acquirer all data needed to perform the financial settlement of the transaction (capture). Should the acquirer not receive a correct response to an AcceptorCompletionAdvice message; the card acceptor sends back an AcceptorCompletionAdvice message to the acquirer."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCmpltnAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_W9_P8KMVEeCJ6YNENx4h-w_-1929143436"
    name="Header"
    definition="Completion advice message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SwPX2gEcEeCQm6a_G2yO_w_-2124028495" />
  <messageBuildingBlock
    xmi:id="_W9_P8aMVEeCJ6YNENx4h-w_808377335"
    name="CompletionAdvice"
    definition="Information related to the completion advice."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvc"
    complexType="_Svo66AEcEeCQm6a_G2yO_w_-1708512614" />
  <messageBuildingBlock
    xmi:id="_W9_P8qMVEeCJ6YNENx4h-w_-83776970"
    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="003"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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