caaa.002.001.05
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
%% AcceptorAuthorisationResponseV05 recursion level 0 with max 0
AcceptorAuthorisationResponseV05 *-- "1..1" Header30 : Header
AcceptorAuthorisationResponseV05 *-- "1..1" AcceptorAuthorisationResponse5 : AuthorisationResponse
AcceptorAuthorisationResponseV05 *-- "0..1" ContentInformationType15 : 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
%% Header30 recursion level 0 with max 1
class Header30{
MessageFunction MessageFunction10Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header30 *-- "1..1" GenericIdentification53 : InitiatingParty
Header30 *-- "0..1" GenericIdentification94 : RecipientParty
Header30 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification
Header30 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction10Code - 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 |
| 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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification94 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability5 - 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
%% AcceptorAuthorisationResponse5 recursion level 0 with max 1
AcceptorAuthorisationResponse5 *-- "1..1" CardPaymentEnvironment46 : Environment
AcceptorAuthorisationResponse5 *-- "1..1" CardPaymentTransaction53 : Transaction
AcceptorAuthorisationResponse5 *-- "1..1" CardPaymentTransaction54 : TransactionResponse
AcceptorAuthorisationResponse5 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment46 recursion level 1 with max 1
CardPaymentEnvironment46 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment46 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment46 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment46 *-- "0..1" PaymentCard19 : Card
CardPaymentEnvironment46 *-- "0..1" CardPaymentToken2 : PaymentToken
%% CardPaymentTransaction53 recursion level 1 with max 1
class CardPaymentTransaction53{
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
MerchantReferenceData IsoMax70Text
}
CardPaymentTransaction53 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction53 *-- "1..1" CardPaymentTransactionDetails42 : TransactionDetails
%% CardPaymentTransaction54 recursion level 1 with max 1
CardPaymentTransaction54 *-- "1..1" AuthorisationResult10 : AuthorisationResult
CardPaymentTransaction54 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction54 *-- "0..0" Product4 : AllowedProductCode
CardPaymentTransaction54 *-- "0..0" Product4 : NotAllowedProductCode
CardPaymentTransaction54 *-- "0..0" Product5 : AdditionalAvailableProduct
CardPaymentTransaction54 *-- "0..1" AmountAndDirection41 : Balance
CardPaymentTransaction54 *-- "0..1" ContentInformationType10 : ProtectedBalance
CardPaymentTransaction54 *-- "0..0" Action6 : Action
CardPaymentTransaction54 *-- "0..1" CurrencyConversion6 : CurrencyConversionEligibility
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AcceptorAuthorisationResponse5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment46 - Required 1..1 |
| Transaction | Authorisation of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction53 - Required 1..1 |
| TransactionResponse | Authorisation response from the acquirer. Authorisation of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction54 - 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
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType15 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). | AuthenticatedData4 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorAuthorisationResponseV05 implementation follows a specific implementaiton pattern. First of all, AcceptorAuthorisationResponseV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorAuthorisationResponseV05Document implements IOuterDocument. Because AcceptorAuthorisationResponseV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorAuthorisationResponseV05.
classDiagram
class IOuterRecord
AcceptorAuthorisationResponseV05 --|> IOuterRecord : Implements
AcceptorAuthorisationResponseV05Document --|> IOuterDocument~AcceptorAuthorisationResponseV05~ : Implements
class IOuterDocument~AcceptorAuthorisationResponseV05~ {
AcceptorAuthorisationResponseV05 Message
}
Document wrapper for serialization
The only real purpose AcceptorAuthorisationResponseV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.002.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorAuthorisationResponseV05.ToDocument() method. The returned AcceptorAuthorisationResponseV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorAuthorisationResponseV05Document *-- AcceptorAuthorisationResponseV05 : 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.05">
<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="_oN7qgY0oEeWzoK7sd7oTyw"
nextVersions="_UaSeUap0EeanIZ10Ka8PnA"
previousVersion="_NVsYsWkgEeSTIuB9A-QJ6g"
name="AcceptorAuthorisationResponseV05"
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">
<doclet
xmi:id="_oN7qg40oEeWzoK7sd7oTyw"
type="purpose" />
<messageBuildingBlock
xmi:id="_oN7qhY0oEeWzoK7sd7oTyw"
nextVersions="_UaSeVap0EeanIZ10Ka8PnA"
previousVersion="_NVsYtWkgEeSTIuB9A-QJ6g"
name="Header"
definition="Authorisation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_IWFRgY0PEeWRYffwL7E13A" />
<messageBuildingBlock
xmi:id="_oN7qh40oEeWzoK7sd7oTyw"
nextVersions="_UaSeV6p0EeanIZ10Ka8PnA"
previousVersion="_NVsYt2kgEeSTIuB9A-QJ6g"
name="AuthorisationResponse"
definition="Information related to the response of the authorisation."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AuthstnRspn"
complexType="_IakKEY0pEeWzoK7sd7oTyw" />
<messageBuildingBlock
xmi:id="_oN7qiY0oEeWzoK7sd7oTyw"
nextVersions="_UaSeWap0EeanIZ10Ka8PnA"
previousVersion="_NVsYuWkgEeSTIuB9A-QJ6g"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="002"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.