Iso20022

TransactionAdviceV01

caaa.020.001.01

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
%% TransactionAdviceV01 recursion level 0 with max 0
TransactionAdviceV01 *-- "1..1" Header58 : Header
TransactionAdviceV01 *-- "1..1" AcceptorCompletionAdvice9 : TransactionAdvice
TransactionAdviceV01 *-- "0..1" ContentInformationType24 : 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
%% Header58 recursion level 0 with max 1
class Header58{
    MessageFunction MessageFunction41Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header58 *-- "1..1" GenericIdentification176 : InitiatingParty
Header58 *-- "0..1" GenericIdentification177 : RecipientParty
Header58 *-- "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

Header58 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction41Code - 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
%% AcceptorCompletionAdvice9 recursion level 0 with max 1
AcceptorCompletionAdvice9 *-- "1..1" CardPaymentEnvironment74 : Environment
AcceptorCompletionAdvice9 *-- "0..1" CardPaymentContext28 : Context
AcceptorCompletionAdvice9 *-- "1..1" CardPaymentTransaction99 : Transaction
AcceptorCompletionAdvice9 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment74 recursion level 1 with max 1
CardPaymentEnvironment74 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment74 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment74 *-- "0..1" PointOfInteraction10 : POI
CardPaymentEnvironment74 *-- "0..1" PaymentCard30 : Card
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment74 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment74 *-- "0..1" CardPaymentToken5 : PaymentToken
CardPaymentEnvironment74 *-- "0..1" Cardholder16 : Cardholder
CardPaymentEnvironment74 *-- "0..1" ContentInformationType22 : ProtectedCardholderData
%% CardPaymentContext28 recursion level 1 with max 1
CardPaymentContext28 *-- "0..1" PaymentContext27 : PaymentContext
CardPaymentContext28 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext28 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% CardPaymentTransaction99 recursion level 1 with max 1
class CardPaymentTransaction99{
    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
}
CardPaymentTransaction99 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction99 *-- "0..1" CardPaymentTransaction101 : OriginalTransaction
CardPaymentTransaction99 *-- "1..1" CardPaymentTransactionDetails48 : TransactionDetails
CardPaymentTransaction99 *-- "0..1" AuthorisationResult11 : AuthorisationResult
CardPaymentTransaction99 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction99 *-- "0..1" CardAccount15 : AccountFrom
CardPaymentTransaction99 *-- "0..1" CardAccount15 : AccountTo
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorCompletionAdvice9 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment74 - 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. CardPaymentTransaction99 - 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
%% ContentInformationType24 recursion level 0 with max 1
class ContentInformationType24{
    ContentType ContentType2Code
}
ContentInformationType24 *-- "1..1" AuthenticatedData6 : AuthenticatedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType24 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). AuthenticatedData6 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransactionAdviceV01 --|> IOuterRecord : Implements
    TransactionAdviceV01Document --|> IOuterDocument~TransactionAdviceV01~ : Implements
    class IOuterDocument~TransactionAdviceV01~ {
        TransactionAdviceV01 Message
     }

Document wrapper for serialization

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

classDiagram
    TransactionAdviceV01Document *-- TransactionAdviceV01 : 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.01">
    <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="_3aVR4BBiEeqgJK7e3n_EXA"
  nextVersions="_8yocYS5AEeunNvJlR_vCbg"
  name="TransactionAdviceV01"
  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="_3t2OURBjEeqgJK7e3n_EXA"
    nextVersions="_8yocYy5AEeunNvJlR_vCbg"
    name="Header"
    definition="Completion advice message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_-_R68QuJEeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_7B_foRBjEeqgJK7e3n_EXA"
    nextVersions="_8yocZS5AEeunNvJlR_vCbg"
    name="TransactionAdvice"
    definition="Information related to the outcome of the transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxAdvc"
    complexType="_FxR4kQudEeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_79gFoRBjEeqgJK7e3n_EXA"
    nextVersions="_8yocZy5AEeunNvJlR_vCbg"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_GpvT8QuEEeqYM5yH99IYQw" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="020"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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