caaa.002.001.07
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
%% AcceptorAuthorisationResponseV07 recursion level 0 with max 0
AcceptorAuthorisationResponseV07 *-- "1..1" Header35 : Header
AcceptorAuthorisationResponseV07 *-- "1..1" AcceptorAuthorisationResponse7 : AuthorisationResponse
AcceptorAuthorisationResponseV07 *-- "0..1" ContentInformationType16 : 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
%% Header35 recursion level 0 with max 1
class Header35{
MessageFunction MessageFunction14Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header35 *-- "1..1" GenericIdentification53 : InitiatingParty
Header35 *-- "0..1" GenericIdentification94 : RecipientParty
Header35 *-- "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
Header35 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction14Code - 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
%% AcceptorAuthorisationResponse7 recursion level 0 with max 1
AcceptorAuthorisationResponse7 *-- "1..1" CardPaymentEnvironment69 : Environment
AcceptorAuthorisationResponse7 *-- "1..1" CardPaymentTransaction77 : Transaction
AcceptorAuthorisationResponse7 *-- "1..1" CardPaymentTransaction84 : TransactionResponse
AcceptorAuthorisationResponse7 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment69 recursion level 1 with max 1
CardPaymentEnvironment69 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment69 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment69 *-- "0..1" CardPaymentToken4 : PaymentToken
%% CardPaymentTransaction77 recursion level 1 with max 1
class CardPaymentTransaction77{
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
MerchantReferenceData IsoMax70Text
}
CardPaymentTransaction77 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction77 *-- "1..1" CardPaymentTransactionDetails28 : TransactionDetails
%% CardPaymentTransaction84 recursion level 1 with max 1
CardPaymentTransaction84 *-- "1..1" AuthorisationResult10 : AuthorisationResult
CardPaymentTransaction84 *-- "0..0" TransactionVerificationResult4 : TransactionVerificationResult
CardPaymentTransaction84 *-- "0..0" Product4 : AllowedProductCode
CardPaymentTransaction84 *-- "0..0" Product4 : NotAllowedProductCode
CardPaymentTransaction84 *-- "0..0" Product5 : AdditionalAvailableProduct
CardPaymentTransaction84 *-- "0..1" AmountAndDirection93 : Balance
CardPaymentTransaction84 *-- "0..1" ContentInformationType17 : ProtectedBalance
CardPaymentTransaction84 *-- "0..0" Action8 : Action
CardPaymentTransaction84 *-- "0..1" CurrencyConversion14 : CurrencyConversionEligibility
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AcceptorAuthorisationResponse7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment69 - Required 1..1 |
| Transaction | Authorisation of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction77 - Required 1..1 |
| TransactionResponse | Authorisation response from the acquirer. Authorisation of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction84 - 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
%% ContentInformationType16 recursion level 0 with max 1
class ContentInformationType16{
ContentType ContentType2Code
}
ContentInformationType16 *-- "1..1" AuthenticatedData5 : AuthenticatedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType16 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). | AuthenticatedData5 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorAuthorisationResponseV07 implementation follows a specific implementaiton pattern. First of all, AcceptorAuthorisationResponseV07 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorAuthorisationResponseV07Document implements IOuterDocument. Because AcceptorAuthorisationResponseV07 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorAuthorisationResponseV07.
classDiagram
class IOuterRecord
AcceptorAuthorisationResponseV07 --|> IOuterRecord : Implements
AcceptorAuthorisationResponseV07Document --|> IOuterDocument~AcceptorAuthorisationResponseV07~ : Implements
class IOuterDocument~AcceptorAuthorisationResponseV07~ {
AcceptorAuthorisationResponseV07 Message
}
Document wrapper for serialization
The only real purpose AcceptorAuthorisationResponseV07Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.002.001.07’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorAuthorisationResponseV07.ToDocument() method. The returned AcceptorAuthorisationResponseV07Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorAuthorisationResponseV07Document *-- AcceptorAuthorisationResponseV07 : 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.07">
<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="_8KyGwdnGEeeN3v2fup_Shw"
nextVersions="_Siuo4deeEeiJyp_aycJaTw"
previousVersion="_UaSeUap0EeanIZ10Ka8PnA"
name="AcceptorAuthorisationResponseV07"
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="_8Kyt0dnGEeeN3v2fup_Shw"
type="purpose" />
<messageBuildingBlock
xmi:id="_8Kyt09nGEeeN3v2fup_Shw"
nextVersions="_Siuo5deeEeiJyp_aycJaTw"
previousVersion="_UaSeVap0EeanIZ10Ka8PnA"
name="Header"
definition="Authorisation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_igU6wdnGEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_8Kyt1dnGEeeN3v2fup_Shw"
nextVersions="_SivP8deeEeiJyp_aycJaTw"
previousVersion="_UaSeV6p0EeanIZ10Ka8PnA"
name="AuthorisationResponse"
definition="Information related to the response of the authorisation."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AuthstnRspn"
complexType="_t05mMdtOEee9e6xduATmQg" />
<messageBuildingBlock
xmi:id="_8Kyt19nGEeeN3v2fup_Shw"
nextVersions="_SivP89eeEeiJyp_aycJaTw"
previousVersion="_UaSeWap0EeanIZ10Ka8PnA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_Wb7MEds3Eee9e6xduATmQg" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="002"
flavour="001"
version="07" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.