Iso20022

AcceptorCompletionAdviceV12

caaa.003.001.12

The AcceptorCompletionAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the outcome of the payment at the acceptor, and to transfer the financial data of the transaction to the acquirer (capture). A AcceptorCompletionAdvice message is also sent to reverse an approved authorisation and any associated financial transfer (capture), if the card payment transaction could not be completed successfully.

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
%% AcceptorCompletionAdviceV12 recursion level 0 with max 0
AcceptorCompletionAdviceV12 *-- "1..1" Header70 : Header
AcceptorCompletionAdviceV12 *-- "1..1" AcceptorCompletionAdvice12 : CompletionAdvice
AcceptorCompletionAdviceV12 *-- "0..1" ContentInformationType36 : 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
%% Header70 recursion level 0 with max 1
class Header70{
    MessageFunction MessageFunction46Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header70 *-- "1..1" GenericIdentification176 : InitiatingParty
Header70 *-- "0..1" GenericIdentification177 : RecipientParty
Header70 *-- "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

Header70 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction46Code - 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

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
%% AcceptorCompletionAdvice12 recursion level 0 with max 1
AcceptorCompletionAdvice12 *-- "1..1" CardPaymentEnvironment79 : Environment
AcceptorCompletionAdvice12 *-- "0..1" CardPaymentContext30 : Context
AcceptorCompletionAdvice12 *-- "1..1" CardPaymentTransaction125 : Transaction
AcceptorCompletionAdvice12 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment79 recursion level 1 with max 1
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : ServiceProvider
CardPaymentEnvironment79 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment79 *-- "0..1" PointOfInteraction13 : POI
CardPaymentEnvironment79 *-- "0..1" PaymentCard33 : Card
CardPaymentEnvironment79 *-- "0..1" Check1 : Check
CardPaymentEnvironment79 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment79 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment79 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment79 *-- "0..1" MerchantToken2 : MerchantToken
CardPaymentEnvironment79 *-- "0..1" Cardholder20 : Cardholder
CardPaymentEnvironment79 *-- "0..1" ContentInformationType35 : ProtectedCardholderData
CardPaymentEnvironment79 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext30 recursion level 1 with max 1
CardPaymentContext30 *-- "0..1" PaymentContext29 : PaymentContext
CardPaymentContext30 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext30 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% CardPaymentTransaction125 recursion level 1 with max 1
class CardPaymentTransaction125{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType12Code
    AdditionalService CardPaymentServiceType9Code
    ServiceAttribute CardPaymentServiceType14Code
    LastTransactionFlag IsoTrueFalseIndicator
    MerchantCategoryCode IsoMin3Max4Text
    CustomerConsent IsoTrueFalseIndicator
    CardProgrammeProposed IsoMax35Text
    CardProgrammeApplied IsoMax35Text
    SaleReferenceIdentification IsoMax35Text
    TransactionSuccess IsoTrueFalseIndicator
    Reversal IsoTrueFalseIndicator
    MerchantOverride IsoTrueFalseIndicator
    FailureReason FailureReason3Code
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax140Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax140Text
    IssuerCITIdentification IsoMax140Text
    MerchantCITIdentification IsoMax140Text
    MerchantReferenceData IsoMax70Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction125 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction125 *-- "0..1" CardPaymentTransaction122 : OriginalTransaction
CardPaymentTransaction125 *-- "1..1" CardPaymentTransactionDetails52 : TransactionDetails
CardPaymentTransaction125 *-- "0..1" AuthorisationResult18 : AuthorisationResult
CardPaymentTransaction125 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction125 *-- "0..1" CardAccount16 : AccountFrom
CardPaymentTransaction125 *-- "0..1" CardAccount16 : AccountTo
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorCompletionAdvice12 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment79 - Required 1..1
Context Context in which the transaction is performed (payment and sale). CardPaymentContext30 - Optional 0..1
Transaction Card payment transaction between an acceptor and an acquirer. CardPaymentTransaction125 - Required 1..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
%% ContentInformationType36 recursion level 0 with max 1
class ContentInformationType36{
    ContentType ContentType2Code
}
ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType36 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). AuthenticatedData9 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCompletionAdviceV12 --|> IOuterRecord : Implements
    AcceptorCompletionAdviceV12Document --|> IOuterDocument~AcceptorCompletionAdviceV12~ : Implements
    class IOuterDocument~AcceptorCompletionAdviceV12~ {
        AcceptorCompletionAdviceV12 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCompletionAdviceV12Document *-- AcceptorCompletionAdviceV12 : 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.12">
    <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="_hvLqgXMJEe2vXY6MoVq19w"
  previousVersion="_vyW1sU3iEey_VecAUE-C9Q"
  name="AcceptorCompletionAdviceV12"
  definition="The AcceptorCompletionAdvice message is sent by an acceptor (or its agent) to notify the acquirer (or its agent) of the outcome of the payment at the acceptor, and to transfer the financial data of the transaction to the acquirer (capture).&#xD;&#xA;A AcceptorCompletionAdvice message is also sent to reverse an approved authorisation and any associated financial transfer (capture), if the card payment transaction could not be completed successfully."
  registrationStatus="Registered"
  messageSet="_uZD3QJVOEeO6Q83g-JIX_w"
  xmlTag="AccptrCmpltnAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_hvLqg3MJEe2vXY6MoVq19w"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_hvLqhXMJEe2vXY6MoVq19w"
    previousVersion="_vyXcw03iEey_VecAUE-C9Q"
    name="Header"
    definition="Completion advice message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_15eK4XJLEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_hvLqh3MJEe2vXY6MoVq19w"
    previousVersion="_vyXcxU3iEey_VecAUE-C9Q"
    name="CompletionAdvice"
    definition="Information related to the completion advice."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltnAdvc"
    complexType="_Ry3V0HJbEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_hvM4oHMJEe2vXY6MoVq19w"
    previousVersion="_vyXcx03iEey_VecAUE-C9Q"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="003"
    flavour="001"
    version="12" />
</messageDefinition>

ISO Building Blocks

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