caaa.001.001.01
Scope The AcceptorAuthorisationRequest message is sent by the card acceptor to the acquirer or its agent when an online authorisation is required for the card payment transaction. Usage The AcceptorAuthorisationRequest message may embed the information required for transferring to the acquirer the data needed to perform the financial settlement of the transaction (capture). An intermediary agent may act on behalf of the card acceptor or of the acquirer in providing additional functionality such as: switching to different acquirers, loyalty processing or management of the acceptor system.
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
%% AcceptorAuthorisationRequestV01 recursion level 0 with max 0
AcceptorAuthorisationRequestV01 *-- "1..1" Header1 : Header
AcceptorAuthorisationRequestV01 *-- "1..1" AcceptorAuthorisationRequest1 : AuthorisationRequest
AcceptorAuthorisationRequestV01 *-- "1..1" ContentInformationType3 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Authorisation request 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 |
AuthorisationRequest building block
Information related to the authorisation request. Authorisation request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorAuthorisationRequest1 recursion level 0 with max 1
AcceptorAuthorisationRequest1 *-- "1..1" CardPaymentEnvironment1 : Environment
AcceptorAuthorisationRequest1 *-- "1..1" CardPaymentContext1 : Context
AcceptorAuthorisationRequest1 *-- "1..1" CardPaymentTransaction1 : Transaction
%% CardPaymentEnvironment1 recursion level 1 with max 1
CardPaymentEnvironment1 *-- "0..1" Acquirer1 : Acquirer
CardPaymentEnvironment1 *-- "0..1" Organisation5 : Merchant
CardPaymentEnvironment1 *-- "1..1" PointOfInteraction1 : POI
CardPaymentEnvironment1 *-- "1..1" PaymentCard1 : Card
CardPaymentEnvironment1 *-- "0..1" Cardholder1 : Cardholder
%% CardPaymentContext1 recursion level 1 with max 1
CardPaymentContext1 *-- "1..1" PaymentContext1 : PaymentContext
CardPaymentContext1 *-- "0..1" SaleContext1 : SaleContext
%% CardPaymentTransaction1 recursion level 1 with max 1
class CardPaymentTransaction1{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType1Code
AdditionalService CardPaymentServiceType2Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
InitiatorTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction1 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction1 *-- "0..1" CardPaymentTransaction8 : OriginalTransaction
CardPaymentTransaction1 *-- "1..1" CardPaymentTransactionDetails1 : TransactionDetails
AcceptorAuthorisationRequest1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment1 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext1 - Required 1..1 |
| Transaction | Card payment transaction for which the authorisation is requested. | CardPaymentTransaction1 - 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 AcceptorAuthorisationRequestV01 implementation follows a specific implementaiton pattern. First of all, AcceptorAuthorisationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorAuthorisationRequestV01Document implements IOuterDocument. Because AcceptorAuthorisationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorAuthorisationRequestV01.
classDiagram
class IOuterRecord
AcceptorAuthorisationRequestV01 --|> IOuterRecord : Implements
AcceptorAuthorisationRequestV01Document --|> IOuterDocument~AcceptorAuthorisationRequestV01~ : Implements
class IOuterDocument~AcceptorAuthorisationRequestV01~ {
AcceptorAuthorisationRequestV01 Message
}
Document wrapper for serialization
The only real purpose AcceptorAuthorisationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.001.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorAuthorisationRequestV01.ToDocument() method. The returned AcceptorAuthorisationRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorAuthorisationRequestV01Document *-- AcceptorAuthorisationRequestV01 : 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.001.001.01">
<AccptrAuthstnReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<AuthstnReq>
<!-- AuthorisationRequest inner content -->
</AuthstnReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrAuthstnReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_ghrzxaMVEeCJ6YNENx4h-w_1039526828"
nextVersions="_kXA6QQvfEeK9Xewg3qiFQA"
name="AcceptorAuthorisationRequestV01"
definition="Scope
The AcceptorAuthorisationRequest message is sent by the card acceptor to the acquirer or its agent when an online authorisation is required for the card payment transaction.
Usage
The AcceptorAuthorisationRequest message may embed the information required for transferring to the acquirer the data needed to perform the financial settlement of the transaction (capture). An intermediary agent may act on behalf of the card acceptor or of the acquirer in providing additional functionality such as: switching to different acquirers, loyalty processing or management of the acceptor system."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrAuthstnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_ghrzxqMVEeCJ6YNENx4h-w_1464733610"
name="Header"
definition="Authorisation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
<messageBuildingBlock
xmi:id="_ghrzx6MVEeCJ6YNENx4h-w_-2042121614"
name="AuthorisationRequest"
definition="Information related to the authorisation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AuthstnReq"
complexType="_SwFm0QEcEeCQm6a_G2yO_w_-200093318" />
<messageBuildingBlock
xmi:id="_ghrzyKMVEeCJ6YNENx4h-w_-1655113788"
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="001"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.