caaa.024.001.03
The AcceptorTransactionLogReportRequest message is sent by an Acceptor to an Acquirer or its IntermediaryAgent to request a report service.
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
%% AcceptorTransactionLogReportRequestV03 recursion level 0 with max 0
AcceptorTransactionLogReportRequestV03 *-- "1..1" Header70 : Header
AcceptorTransactionLogReportRequestV03 *-- "1..1" ReportRequest6 : ReportRequest
AcceptorTransactionLogReportRequestV03 *-- "0..1" ContentInformationType36 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Set of characteristics related to the transfer of the request. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header70 recursion level 0 with max 1
class Header70{
MessageFunction MessageFunction46Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header70 *-- "1..1" GenericIdentification176 : InitiatingParty
Header70 *-- "0..1" GenericIdentification177 : RecipientParty
Header70 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
Identification IsoMax35Text
Type PartyType33Code
Issuer PartyType33Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification
Header70 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction46Code - 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 |
| ReTransmissionCounter | Number of retransmissions of the message. | IsoMax3NumericText - Optional 0..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. | GenericIdentification176 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification177 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability8 - Unknown 0..0 |
ReportRequest building block
Information related to the report request. Specifies the environment, the context and the services to be used with this message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReportRequest6 recursion level 0 with max 1
class ReportRequest6{
ServiceContent RetailerService6Code
}
ReportRequest6 *-- "1..1" CardPaymentEnvironment79 : Environment
ReportRequest6 *-- "1..1" CardPaymentContext30 : Context
ReportRequest6 *-- "0..1" ReportTransactionRequest1 : ReportTransactionRequest
ReportRequest6 *-- "0..1" ReportGetTotalsRequest1 : ReportGetTotalsRequest
ReportRequest6 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment79 recursion level 1 with max 1
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment79 *-- "0..1" Acquirer10 : ServiceProvider
CardPaymentEnvironment79 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment79 *-- "0..1" PointOfInteraction13 : POI
CardPaymentEnvironment79 *-- "0..1" PaymentCard33 : Card
CardPaymentEnvironment79 *-- "0..1" Check1 : Check
CardPaymentEnvironment79 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment79 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment79 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment79 *-- "0..1" MerchantToken2 : MerchantToken
CardPaymentEnvironment79 *-- "0..1" Cardholder20 : Cardholder
CardPaymentEnvironment79 *-- "0..1" ContentInformationType35 : ProtectedCardholderData
CardPaymentEnvironment79 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext30 recursion level 1 with max 1
CardPaymentContext30 *-- "0..1" PaymentContext29 : PaymentContext
CardPaymentContext30 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext30 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% ReportTransactionRequest1 recursion level 1 with max 1
class ReportTransactionRequest1{
DescendingOrder IsoTrueFalseIndicator
BlockStart IsoPositiveNumber
BlockStop IsoPositiveNumber
}
ReportTransactionRequest1 *-- "1..0" SearchCriteria1 : SearchCriteria
ReportTransactionRequest1 *-- "0..1" SearchOutputOrder1 : SearchOutputOrder
%% ReportGetTotalsRequest1 recursion level 1 with max 1
class ReportGetTotalsRequest1{
TotalDetails TotalDetails1Code
}
ReportGetTotalsRequest1 *-- "0..1" TotalFilter1 : TotalFilter
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
ReportRequest6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment79 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext30 - Required 1..1 |
| ServiceContent | Define the type of service requested. | RetailerService6Code - Required 1..1 |
| ReportTransactionRequest | Content of the Transaction Report Request message. | ReportTransactionRequest1 - Optional 0..1 |
| ReportGetTotalsRequest | Content of the Get Totals Request message. | ReportGetTotalsRequest1 - Optional 0..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 or a digital signature. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType36 recursion level 0 with max 1
class ContentInformationType36{
ContentType ContentType2Code
}
ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType36 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). | AuthenticatedData9 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorTransactionLogReportRequestV03 implementation follows a specific implementaiton pattern. First of all, AcceptorTransactionLogReportRequestV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorTransactionLogReportRequestV03Document implements IOuterDocument. Because AcceptorTransactionLogReportRequestV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorTransactionLogReportRequestV03.
classDiagram
class IOuterRecord
AcceptorTransactionLogReportRequestV03 --|> IOuterRecord : Implements
AcceptorTransactionLogReportRequestV03Document --|> IOuterDocument~AcceptorTransactionLogReportRequestV03~ : Implements
class IOuterDocument~AcceptorTransactionLogReportRequestV03~ {
AcceptorTransactionLogReportRequestV03 Message
}
Document wrapper for serialization
The only real purpose AcceptorTransactionLogReportRequestV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.024.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorTransactionLogReportRequestV03.ToDocument() method. The returned AcceptorTransactionLogReportRequestV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorTransactionLogReportRequestV03Document *-- AcceptorTransactionLogReportRequestV03 : 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.024.001.03">
<AccptrTxLgRptReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RptReq>
<!-- ReportRequest inner content -->
</RptReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrTxLgRptReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_1jKvYXMqEe2vXY6MoVq19w"
previousVersion="_L8IqIU6vEeyGi9JAv6wq7Q"
name="AcceptorTransactionLogReportRequestV03"
definition="The AcceptorTransactionLogReportRequest message is sent by an Acceptor to an Acquirer or its IntermediaryAgent to request a report service."
registrationStatus="Registered"
messageSet="_uZD3QJVOEeO6Q83g-JIX_w"
xmlTag="AccptrTxLgRptReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_1jKvY3MqEe2vXY6MoVq19w"
previousVersion="_L8IqI06vEeyGi9JAv6wq7Q"
name="Header"
definition="Set of characteristics related to the transfer of the request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_15eK4XJLEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_1jKvZXMqEe2vXY6MoVq19w"
previousVersion="_L8IqJU6vEeyGi9JAv6wq7Q"
name="ReportRequest"
definition="Information related to the report request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptReq"
complexType="_6PYB4XJQEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_1jKvZ3MqEe2vXY6MoVq19w"
previousVersion="_L8IqJ06vEeyGi9JAv6wq7Q"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="024"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.