Iso20022

AcceptorAuthorisationResponseV02

caaa.002.001.02

The AcceptorAuthorisationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the result of the validation made by issuer about the payment transaction.

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
%% AcceptorAuthorisationResponseV02 recursion level 0 with max 0
AcceptorAuthorisationResponseV02 *-- "1..1" Header1 : Header
AcceptorAuthorisationResponseV02 *-- "1..1" AcceptorAuthorisationResponse2 : AuthorisationResponse
AcceptorAuthorisationResponseV02 *-- "1..1" ContentInformationType6 : SecurityTrailer

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

Header building block

Authorisation response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header1 recursion level 0 with max 1
class Header1{
    MessageFunction MessageFunction1Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header1 *-- "1..1" GenericIdentification32 : InitiatingParty
Header1 *-- "0..1" GenericIdentification32 : RecipientParty
Header1 *-- "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

Header1 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
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

AuthorisationResponse building block

Information related to the response of the authorisation. Authorisation response from the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorAuthorisationResponse2 recursion level 0 with max 1
AcceptorAuthorisationResponse2 *-- "1..1" CardPaymentEnvironment11 : Environment
AcceptorAuthorisationResponse2 *-- "1..1" CardPaymentTransaction2 : Transaction
AcceptorAuthorisationResponse2 *-- "1..1" CardPaymentTransaction18 : TransactionResponse
%% CardPaymentEnvironment11 recursion level 1 with max 1
CardPaymentEnvironment11 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment11 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment11 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment11 *-- "0..1" ContentInformationType5 : ProtectedCardData
CardPaymentEnvironment11 *-- "0..1" PlainCardData3 : PlainCardData
%% CardPaymentTransaction2 recursion level 1 with max 1
class CardPaymentTransaction2{
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax35Text
}
CardPaymentTransaction2 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction2 *-- "1..1" CardPaymentTransactionDetails2 : TransactionDetails
%% CardPaymentTransaction18 recursion level 1 with max 1
class CardPaymentTransaction18{
    Balance IsoImpliedCurrencyAndAmount
    Currency CurrencyCode
}
CardPaymentTransaction18 *-- "1..1" AuthorisationResult1 : AuthorisationResult
CardPaymentTransaction18 *-- "0..1" TransactionVerificationResult2 : TransactionVerificationResult
CardPaymentTransaction18 *-- "0..0" Action2 : Action

AcceptorAuthorisationResponse2 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment11 - Required 1..1
Transaction Authorisation of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction2 - Required 1..1
TransactionResponse Authorisation response from the acquirer. Authorisation of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction18 - 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
%% ContentInformationType6 recursion level 0 with max 1
class ContentInformationType6{
    ContentType ContentType1Code
}
ContentInformationType6 *-- "0..0" AuthenticatedData2 : AuthenticatedData
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent

ContentInformationType6 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). AuthenticatedData2 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorAuthorisationResponseV02 --|> IOuterRecord : Implements
    AcceptorAuthorisationResponseV02Document --|> IOuterDocument~AcceptorAuthorisationResponseV02~ : Implements
    class IOuterDocument~AcceptorAuthorisationResponseV02~ {
        AcceptorAuthorisationResponseV02 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorAuthorisationResponseV02Document *-- AcceptorAuthorisationResponseV02 : 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.002.001.02">
    <AccptrAuthstnRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <AuthstnRspn>
            <!-- AuthorisationResponse inner content -->
        </AuthstnRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrAuthstnRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_p76tQQvfEeK9Xewg3qiFQA"
  nextVersions="_gjkcwTGmEeO118ZQJgaQSQ"
  previousVersion="_fvUitaMVEeCJ6YNENx4h-w_-1631980984"
  name="AcceptorAuthorisationResponseV02"
  definition="The AcceptorAuthorisationResponse message is sent by the acquirer (or its agent) to an acceptor (or its agent), to return the result of the validation made by issuer about the payment transaction."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrAuthstnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_p76tQwvfEeK9Xewg3qiFQA"
    nextVersions="_gjkcwzGmEeO118ZQJgaQSQ"
    name="Header"
    definition="Authorisation response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
  <messageBuildingBlock
    xmi:id="_p76tRwvfEeK9Xewg3qiFQA"
    nextVersions="_gjkcxTGmEeO118ZQJgaQSQ"
    name="AuthorisationResponse"
    definition="Information related to the response of the authorisation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AuthstnRspn"
    complexType="_whpaMQvWEeKzJ69IWwzB9Q" />
  <messageBuildingBlock
    xmi:id="_p76tSwvfEeK9Xewg3qiFQA"
    nextVersions="_gjkcxzGmEeO118ZQJgaQSQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_6DM4sQvFEeKzJ69IWwzB9Q" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="002"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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