casp.009.001.03
The SaleToPOIReportRequest message is sent by sale system 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
%% SaleToPOIReportRequestV03 recursion level 0 with max 0
SaleToPOIReportRequestV03 *-- "1..1" Header41 : Header
SaleToPOIReportRequestV03 *-- "1..1" ReportRequest4 : ReportRequest
SaleToPOIReportRequestV03 *-- "0..1" ContentInformationType25 : 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
%% Header41 recursion level 0 with max 1
class Header41{
MessageFunction RetailerMessage1Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
Header41 *-- "1..1" GenericIdentification177 : InitiatingParty
Header41 *-- "0..1" GenericIdentification177 : RecipientParty
Header41 *-- "0..0" Traceability8 : Traceability
%% 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
%% 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
Header41 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | RetailerMessage1Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax35Text - 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. | GenericIdentification177 - 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. This component define the environment, the context and the services to be used with this message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReportRequest4 recursion level 0 with max 1
class ReportRequest4{
ServiceContent RetailerService6Code
}
ReportRequest4 *-- "1..1" CardPaymentEnvironment77 : Environment
ReportRequest4 *-- "1..1" CardPaymentContext28 : Context
ReportRequest4 *-- "0..1" ReportTransactionRequest1 : ReportTransactionRequest
ReportRequest4 *-- "0..1" ReportGetTotalsRequest1 : ReportGetTotalsRequest
ReportRequest4 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment77 recursion level 1 with max 1
CardPaymentEnvironment77 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment77 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment77 *-- "0..1" PointOfInteraction11 : POI
CardPaymentEnvironment77 *-- "0..1" PaymentCard31 : Card
CardPaymentEnvironment77 *-- "0..1" Check1 : Check
CardPaymentEnvironment77 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment77 *-- "0..0" LoyaltyAccount2 : LoyaltyAccount
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment77 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment77 *-- "0..1" MerchantToken1 : MerchantToken
CardPaymentEnvironment77 *-- "0..1" Cardholder17 : Cardholder
CardPaymentEnvironment77 *-- "0..1" ContentInformationType28 : ProtectedCardholderData
CardPaymentEnvironment77 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext28 recursion level 1 with max 1
CardPaymentContext28 *-- "0..1" PaymentContext27 : PaymentContext
CardPaymentContext28 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext28 *-- "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
ReportRequest4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment77 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext28 - 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 data. protected by a MAC or a digital signature. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType25 recursion level 0 with max 1
class ContentInformationType25{
ContentType ContentType2Code
}
ContentInformationType25 *-- "0..1" AuthenticatedData7 : AuthenticatedData
ContentInformationType25 *-- "0..1" SignedData6 : SignedData
%% AuthenticatedData7 recursion level 1 with max 1
class AuthenticatedData7{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient
AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData6 recursion level 1 with max 1
class SignedData6{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData6 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData6 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData6 *-- "0..0" Signer5 : Signer
ContentInformationType25 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). | AuthenticatedData7 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData6 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the SaleToPOIReportRequestV03 implementation follows a specific implementaiton pattern. First of all, SaleToPOIReportRequestV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIReportRequestV03Document implements IOuterDocument. Because SaleToPOIReportRequestV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIReportRequestV03.
classDiagram
class IOuterRecord
SaleToPOIReportRequestV03 --|> IOuterRecord : Implements
SaleToPOIReportRequestV03Document --|> IOuterDocument~SaleToPOIReportRequestV03~ : Implements
class IOuterDocument~SaleToPOIReportRequestV03~ {
SaleToPOIReportRequestV03 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIReportRequestV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.009.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIReportRequestV03.ToDocument() method. The returned SaleToPOIReportRequestV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIReportRequestV03Document *-- SaleToPOIReportRequestV03 : 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:casp.009.001.03">
<SaleToPOIRptReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RptReq>
<!-- ReportRequest inner content -->
</RptReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIRptReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_kfKQcS5LEeunNvJlR_vCbg"
nextVersions="_ZsT1cU6vEeyGi9JAv6wq7Q"
previousVersion="_GAgmcQ1VEeqjM-rxn3HuXQ"
name="SaleToPOIReportRequestV03"
definition="The SaleToPOIReportRequest message is sent by sale system to request a report service."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOIRptReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_kfKQcy5LEeunNvJlR_vCbg"
nextVersions="_ZsT1c06vEeyGi9JAv6wq7Q"
previousVersion="_GAhNgQ1VEeqjM-rxn3HuXQ"
name="Header"
definition="Set of characteristics related to the transfer of the request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_BwWUYQuKEeqYM5yH99IYQw" />
<messageBuildingBlock
xmi:id="_kfKQdS5LEeunNvJlR_vCbg"
nextVersions="_ZsUcgU6vEeyGi9JAv6wq7Q"
previousVersion="_GAhNgw1VEeqjM-rxn3HuXQ"
name="ReportRequest"
definition="Information related to the report request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptReq"
complexType="_dyK0AS5LEeunNvJlR_vCbg" />
<messageBuildingBlock
xmi:id="_kfKQdy5LEeunNvJlR_vCbg"
nextVersions="_ZsUcg06vEeyGi9JAv6wq7Q"
previousVersion="_GAhNhQ1VEeqjM-rxn3HuXQ"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_kWoPYS8jEeu125Ip9zFcsQ" />
<messageDefinitionIdentifier
businessArea="casp"
messageFunctionality="009"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.