AcceptorAuthorisationResponseV01

caaa.002.001.01

Scope The AcceptorAuthorisationResponse message is sent by the acquirer to inform the card acceptor of the outcome of the authorisation process. The message can be sent directly to the acceptor or through an agent. Usage The AcceptorAuthorisationResponse message is used to indicate one of the possible outcomes of an authorisation process:

a successful authorisation;
a decline from the acquirer for financial reasons;
a decline from the acquirer for technical reasons (for instance, a timeout).

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
%% AcceptorAuthorisationResponseV01 recursion level 0 with max 0
AcceptorAuthorisationResponseV01 *-- "1..1" Header1 : Header
AcceptorAuthorisationResponseV01 *-- "1..1" AcceptorAuthorisationResponse1 : AuthorisationResponse
AcceptorAuthorisationResponseV01 *-- "1..1" ContentInformationType3 : 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
%% AcceptorAuthorisationResponse1 recursion level 0 with max 1
AcceptorAuthorisationResponse1 *-- "1..1" CardPaymentEnvironment3 : Environment
AcceptorAuthorisationResponse1 *-- "1..1" CardPaymentTransaction2 : Transaction
AcceptorAuthorisationResponse1 *-- "1..1" CardPaymentTransaction9 : TransactionResponse
%% CardPaymentEnvironment3 recursion level 1 with max 1
CardPaymentEnvironment3 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment3 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment3 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment3 *-- "0..1" ContentInformationType1 : ProtectedCardData
CardPaymentEnvironment3 *-- "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
%% CardPaymentTransaction9 recursion level 1 with max 1
class CardPaymentTransaction9{
    Balance IsoImpliedCurrencyAndAmount
    Currency CurrencyCode
}
CardPaymentTransaction9 *-- "1..1" AuthorisationResult1 : AuthorisationResult
CardPaymentTransaction9 *-- "0..1" TransactionVerificationResult1 : TransactionVerificationResult
CardPaymentTransaction9 *-- "0..0" Action1 : Action

AcceptorAuthorisationResponse1 members

Member name	Description	Data Type / Multiplicity
Environment	Environment of the transaction.	CardPaymentEnvironment3 - 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.	CardPaymentTransaction9 - 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
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
    ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent

ContentInformationType3 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).	AuthenticatedData1 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorAuthorisationResponseV01 --|> IOuterRecord : Implements
    AcceptorAuthorisationResponseV01Document --|> IOuterDocument~AcceptorAuthorisationResponseV01~ : Implements
    class IOuterDocument~AcceptorAuthorisationResponseV01~ {
        AcceptorAuthorisationResponseV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorAuthorisationResponseV01Document *-- AcceptorAuthorisationResponseV01 : 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.01">
    <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="_fvUitaMVEeCJ6YNENx4h-w_-1631980984"
  nextVersions="_p76tQQvfEeK9Xewg3qiFQA"
  name="AcceptorAuthorisationResponseV01"
  definition="Scope&#xD;&#xA;The AcceptorAuthorisationResponse message is sent by the acquirer to inform the card acceptor of the outcome of the authorisation process. The message can be sent directly to the acceptor or through an agent.&#xD;&#xA;Usage&#xD;&#xA;The AcceptorAuthorisationResponse message is used to indicate one of the possible outcomes of an authorisation process:&#xD;&#xA;- a successful authorisation;&#xD;&#xA;- a decline from the acquirer for financial reasons;&#xD;&#xA;- a decline from the acquirer for technical reasons (for instance, a timeout)."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrAuthstnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_fvUitqMVEeCJ6YNENx4h-w_-1929213849"
    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="_fvUit6MVEeCJ6YNENx4h-w_-930350884"
    name="AuthorisationResponse"
    definition="Information related to the response of the authorisation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AuthstnRspn"
    complexType="_Sv8c6AEcEeCQm6a_G2yO_w_2095572103" />
  <messageBuildingBlock
    xmi:id="_fvUiuKMVEeCJ6YNENx4h-w_112512761"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="002"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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