Iso20022

TransactionAdviceV02

caaa.020.001.02

The TransactionAdvice message is sent by the Acquirer (or Agent) to provide to the POI the outcome of a transaction processed outside of this protocol.

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
%% TransactionAdviceV02 recursion level 0 with max 0
TransactionAdviceV02 *-- "1..1" Header59 : Header
TransactionAdviceV02 *-- "1..1" AcceptorCompletionAdvice10 : TransactionAdvice
TransactionAdviceV02 *-- "0..1" ContentInformationType27 : 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
%% Header59 recursion level 0 with max 1
class Header59{
    MessageFunction MessageFunction42Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header59 *-- "1..1" GenericIdentification176 : InitiatingParty
Header59 *-- "0..1" GenericIdentification177 : RecipientParty
Header59 *-- "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

Header59 members

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

TransactionAdvice building block

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

classDiagram
   direction tb
%% AcceptorCompletionAdvice10 recursion level 0 with max 1
AcceptorCompletionAdvice10 *-- "1..1" CardPaymentEnvironment77 : Environment
AcceptorCompletionAdvice10 *-- "0..1" CardPaymentContext28 : Context
AcceptorCompletionAdvice10 *-- "1..1" CardPaymentTransaction103 : Transaction
AcceptorCompletionAdvice10 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment77 recursion level 1 with max 1
CardPaymentEnvironment77 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment77 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment77 *-- "0..1" PointOfInteraction11 : POI
CardPaymentEnvironment77 *-- "0..1" PaymentCard31 : Card
CardPaymentEnvironment77 *-- "0..1" Check1 : Check
CardPaymentEnvironment77 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment77 *-- "0..0" LoyaltyAccount2 : LoyaltyAccount
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment77 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment77 *-- "0..1" MerchantToken1 : MerchantToken
CardPaymentEnvironment77 *-- "0..1" Cardholder17 : Cardholder
CardPaymentEnvironment77 *-- "0..1" ContentInformationType28 : ProtectedCardholderData
CardPaymentEnvironment77 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext28 recursion level 1 with max 1
CardPaymentContext28 *-- "0..1" PaymentContext27 : PaymentContext
CardPaymentContext28 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext28 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% CardPaymentTransaction103 recursion level 1 with max 1
class CardPaymentTransaction103{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType12Code
    AdditionalService CardPaymentServiceType9Code
    ServiceAttribute CardPaymentServiceType3Code
    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
    MerchantReferenceData IsoMax70Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction103 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction103 *-- "0..1" CardPaymentTransaction106 : OriginalTransaction
CardPaymentTransaction103 *-- "1..1" CardPaymentTransactionDetails49 : TransactionDetails
CardPaymentTransaction103 *-- "0..1" AuthorisationResult15 : AuthorisationResult
CardPaymentTransaction103 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction103 *-- "0..1" CardAccount15 : AccountFrom
CardPaymentTransaction103 *-- "0..1" CardAccount15 : AccountTo
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorCompletionAdvice10 members

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

ContentInformationType27 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). AuthenticatedData7 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransactionAdviceV02 --|> IOuterRecord : Implements
    TransactionAdviceV02Document --|> IOuterDocument~TransactionAdviceV02~ : Implements
    class IOuterDocument~TransactionAdviceV02~ {
        TransactionAdviceV02 Message
     }

Document wrapper for serialization

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

classDiagram
    TransactionAdviceV02Document *-- TransactionAdviceV02 : 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.020.001.02">
    <TxAdvc>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <TxAdvc>
            <!-- TransactionAdvice inner content -->
        </TxAdvc>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </TxAdvc>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_8yocYS5AEeunNvJlR_vCbg"
  nextVersions="_6jZ9cU3iEey_VecAUE-C9Q"
  previousVersion="_3aVR4BBiEeqgJK7e3n_EXA"
  name="TransactionAdviceV02"
  definition="The TransactionAdvice message is sent by the Acquirer (or Agent) to provide to the POI the outcome of a transaction processed outside of this protocol. "
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="TxAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_8yocYy5AEeunNvJlR_vCbg"
    nextVersions="_6jZ9c03iEey_VecAUE-C9Q"
    previousVersion="_3t2OURBjEeqgJK7e3n_EXA"
    name="Header"
    definition="Completion advice message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_Rz5m4S_aEeugIJ3Gvoevmg" />
  <messageBuildingBlock
    xmi:id="_8yocZS5AEeunNvJlR_vCbg"
    nextVersions="_6jZ9dU3iEey_VecAUE-C9Q"
    previousVersion="_7B_foRBjEeqgJK7e3n_EXA"
    name="TransactionAdvice"
    definition="Information related to the outcome of the transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxAdvc"
    complexType="_ujtfkS5AEeunNvJlR_vCbg" />
  <messageBuildingBlock
    xmi:id="_8yocZy5AEeunNvJlR_vCbg"
    nextVersions="_6jZ9d03iEey_VecAUE-C9Q"
    previousVersion="_79gFoRBjEeqgJK7e3n_EXA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_2S4usS8lEeu125Ip9zFcsQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="020"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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