caaa.001.001.07
The AcceptorAuthorisationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to check with the issuer (or its agent) that the account associated to the card has the resources to fund the payment. This checking will include validation of the card data and any additional transaction data provided.
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
%% AcceptorAuthorisationRequestV07 recursion level 0 with max 0
AcceptorAuthorisationRequestV07 *-- "1..1" Header35 : Header
AcceptorAuthorisationRequestV07 *-- "1..1" AcceptorAuthorisationRequest7 : AuthorisationRequest
AcceptorAuthorisationRequestV07 *-- "0..1" ContentInformationType16 : 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
%% 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 |
AuthorisationRequest building block
Information related to the authorisation request. Authorisation request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorAuthorisationRequest7 recursion level 0 with max 1
AcceptorAuthorisationRequest7 *-- "1..1" CardPaymentEnvironment68 : Environment
AcceptorAuthorisationRequest7 *-- "1..1" CardPaymentContext26 : Context
AcceptorAuthorisationRequest7 *-- "1..1" CardPaymentTransaction80 : Transaction
AcceptorAuthorisationRequest7 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment68 recursion level 1 with max 1
CardPaymentEnvironment68 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment68 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment68 *-- "0..1" PointOfInteraction8 : POI
CardPaymentEnvironment68 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment68 *-- "0..1" CardPaymentToken4 : PaymentToken
CardPaymentEnvironment68 *-- "0..1" Cardholder13 : Cardholder
CardPaymentEnvironment68 *-- "0..1" ContentInformationType17 : ProtectedCardholderData
%% CardPaymentContext26 recursion level 1 with max 1
CardPaymentContext26 *-- "0..1" PaymentContext24 : PaymentContext
CardPaymentContext26 *-- "0..1" SaleContext2 : SaleContext
CardPaymentContext26 *-- "0..1" CardDirectDebit1 : DirectDebitContext
%% CardPaymentTransaction80 recursion level 1 with max 1
class CardPaymentTransaction80{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType12Code
AdditionalService CardPaymentServiceType9Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
CustomerConsent IsoTrueFalseIndicator
CardProgrammeProposed IsoMax35Text
CardProgrammeApplied IsoMax35Text
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
MerchantReferenceData IsoMax70Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction80 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction80 *-- "0..1" CardPaymentTransaction79 : OriginalTransaction
CardPaymentTransaction80 *-- "1..1" CardPaymentTransactionDetails45 : TransactionDetails
CardPaymentTransaction80 *-- "0..1" CardAccount14 : AccountFrom
CardPaymentTransaction80 *-- "0..1" CardAccount14 : AccountTo
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AcceptorAuthorisationRequest7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment68 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext26 - Required 1..1 |
| Transaction | Card payment transaction for which the authorisation is requested. | CardPaymentTransaction80 - 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 AcceptorAuthorisationRequestV07 implementation follows a specific implementaiton pattern. First of all, AcceptorAuthorisationRequestV07 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorAuthorisationRequestV07Document implements IOuterDocument. Because AcceptorAuthorisationRequestV07 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorAuthorisationRequestV07.
classDiagram
class IOuterRecord
AcceptorAuthorisationRequestV07 --|> IOuterRecord : Implements
AcceptorAuthorisationRequestV07Document --|> IOuterDocument~AcceptorAuthorisationRequestV07~ : Implements
class IOuterDocument~AcceptorAuthorisationRequestV07~ {
AcceptorAuthorisationRequestV07 Message
}
Document wrapper for serialization
The only real purpose AcceptorAuthorisationRequestV07Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.001.001.07’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorAuthorisationRequestV07.ToDocument() method. The returned AcceptorAuthorisationRequestV07Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorAuthorisationRequestV07Document *-- AcceptorAuthorisationRequestV07 : 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.07">
<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="_19mLwdnGEeeN3v2fup_Shw"
nextVersions="_iVb_kdeREeiJyp_aycJaTw"
previousVersion="_ZqSqQapyEeanIZ10Ka8PnA"
name="AcceptorAuthorisationRequestV07"
definition="The AcceptorAuthorisationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to check with the issuer (or its agent) that the account associated to the card has the resources to fund the payment. This checking will include validation of the card data and any additional transaction data provided."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrAuthstnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_19mLw9nGEeeN3v2fup_Shw"
type="purpose" />
<messageBuildingBlock
xmi:id="_19mLxdnGEeeN3v2fup_Shw"
nextVersions="_iVcmodeREeiJyp_aycJaTw"
previousVersion="_ZqTRU6pyEeanIZ10Ka8PnA"
name="Header"
definition="Authorisation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_igU6wdnGEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_19mLx9nGEeeN3v2fup_Shw"
nextVersions="_iVcmo9eREeiJyp_aycJaTw"
previousVersion="_ZqTRVapyEeanIZ10Ka8PnA"
name="AuthorisationRequest"
definition="Information related to the authorisation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AuthstnReq"
complexType="_x2niwdnbEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_19mLydnGEeeN3v2fup_Shw"
nextVersions="_iVcmpdeREeiJyp_aycJaTw"
previousVersion="_ZqTRV6pyEeanIZ10Ka8PnA"
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="001"
flavour="001"
version="07" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.