Iso20022

AcceptorAuthorisationResponseV12

caaa.002.001.12

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
%% AcceptorAuthorisationResponseV12 recursion level 0 with max 0
AcceptorAuthorisationResponseV12 *-- "1..1" Header70 : Header
AcceptorAuthorisationResponseV12 *-- "1..1" AcceptorAuthorisationResponse12 : AuthorisationResponse
AcceptorAuthorisationResponseV12 *-- "0..1" ContentInformationType36 : 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
%% 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

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
%% AcceptorAuthorisationResponse12 recursion level 0 with max 1
AcceptorAuthorisationResponse12 *-- "1..1" CardPaymentEnvironment79 : Environment
AcceptorAuthorisationResponse12 *-- "1..1" CardPaymentTransaction129 : Transaction
AcceptorAuthorisationResponse12 *-- "1..1" CardPaymentTransaction128 : TransactionResponse
AcceptorAuthorisationResponse12 *-- "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
%% CardPaymentTransaction129 recursion level 1 with max 1
class CardPaymentTransaction129{
    SaleReferenceIdentification IsoMax35Text
    InitiatorTransactionIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax140Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax140Text
    MerchantReferenceData IsoMax70Text
}
CardPaymentTransaction129 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction129 *-- "1..1" CardPaymentTransactionDetails52 : TransactionDetails
%% CardPaymentTransaction128 recursion level 1 with max 1
CardPaymentTransaction128 *-- "1..1" AuthorisationResult17 : AuthorisationResult
CardPaymentTransaction128 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction128 *-- "0..0" Product4 : AllowedProductCode
CardPaymentTransaction128 *-- "0..0" Product4 : NotAllowedProductCode
CardPaymentTransaction128 *-- "0..0" Product5 : AdditionalAvailableProduct
CardPaymentTransaction128 *-- "0..1" AmountAndDirection93 : Balance
CardPaymentTransaction128 *-- "0..1" ContentInformationType35 : ProtectedBalance
CardPaymentTransaction128 *-- "0..0" Action14 : Action
CardPaymentTransaction128 *-- "0..1" CurrencyConversion26 : CurrencyConversionEligibility
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

AcceptorAuthorisationResponse12 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment79 - Required 1..1
Transaction Authorisation of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction129 - Required 1..1
TransactionResponse Authorisation response from the acquirer. Authorisation of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction128 - 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 AcceptorAuthorisationResponseV12 implementation follows a specific implementaiton pattern. First of all, AcceptorAuthorisationResponseV12 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorAuthorisationResponseV12Document implements IOuterDocument. Because AcceptorAuthorisationResponseV12 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorAuthorisationResponseV12.

classDiagram
    class IOuterRecord
    AcceptorAuthorisationResponseV12 --|> IOuterRecord : Implements
    AcceptorAuthorisationResponseV12Document --|> IOuterDocument~AcceptorAuthorisationResponseV12~ : Implements
    class IOuterDocument~AcceptorAuthorisationResponseV12~ {
        AcceptorAuthorisationResponseV12 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorAuthorisationResponseV12Document *-- AcceptorAuthorisationResponseV12 : 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.12">
    <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="_3Gbm0XMHEe2vXY6MoVq19w"
  previousVersion="_spAG4U0YEeybj420QgWBkA"
  name="AcceptorAuthorisationResponseV12"
  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="_uZD3QJVOEeO6Q83g-JIX_w"
  xmlTag="AccptrAuthstnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_3Gbm03MHEe2vXY6MoVq19w"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_3Gbm1XMHEe2vXY6MoVq19w"
    previousVersion="_spAG5U0YEeybj420QgWBkA"
    name="Header"
    definition="Authorisation response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_15eK4XJLEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_3Gbm13MHEe2vXY6MoVq19w"
    previousVersion="_spAG500YEeybj420QgWBkA"
    name="AuthorisationResponse"
    definition="Information related to the response of the authorisation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AuthstnRspn"
    complexType="_qwueYXJXEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_3Gbm2XMHEe2vXY6MoVq19w"
    previousVersion="_spAG6U0YEeybj420QgWBkA"
    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="002"
    flavour="001"
    version="12" />
</messageDefinition>

ISO Building Blocks

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