SaleToPOIReportRequestV01

casp.009.001.01

This message is a request for several kind of Report services that the Sale System (Merchant I.S.) can request to the POI system (Card 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
%% SaleToPOIReportRequestV01 recursion level 0 with max 0
SaleToPOIReportRequestV01 *-- "1..1" Header37 : Header
SaleToPOIReportRequestV01 *-- "1..1" ReportRequest2 : ReportRequest
SaleToPOIReportRequestV01 *-- "0..1" ContentInformationType18 : 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
%% Header37 recursion level 0 with max 1
class Header37{
    MessageFunction RetailerMessage1Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
Header37 *-- "1..1" GenericIdentification171 : InitiatingParty
Header37 *-- "0..1" GenericIdentification171 : RecipientParty
Header37 *-- "0..0" Traceability6 : Traceability
%% GenericIdentification171 recursion level 1 with max 1
class GenericIdentification171{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification171 *-- "0..1" NetworkParameters5 : RemoteAccess
GenericIdentification171 *-- "0..1" Geolocation1 : Geolocation
%% GenericIdentification171 recursion level 1 with max 1
class GenericIdentification171{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification171 *-- "0..1" NetworkParameters5 : RemoteAccess
GenericIdentification171 *-- "0..1" Geolocation1 : Geolocation
%% Traceability6 recursion level 1 with max 1
class Traceability6{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability6 *-- "1..1" GenericIdentification171 : RelayIdentification
  

Header37 members

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
%% ReportRequest2 recursion level 0 with max 1
class ReportRequest2{
    ServiceContent RetailerService6Code
}
ReportRequest2 *-- "1..1" CardPaymentEnvironment73 : Environment
ReportRequest2 *-- "1..1" CardPaymentContext27 : Context
ReportRequest2 *-- "0..1" ReportTransactionRequest1 : ReportTransactionRequest
ReportRequest2 *-- "0..1" ReportGetTotalsRequest1 : ReportGetTotalsRequest
ReportRequest2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment73 recursion level 1 with max 1
CardPaymentEnvironment73 *-- "0..1" Acquirer9 : Acquirer
CardPaymentEnvironment73 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment73 *-- "0..1" PointOfInteraction9 : POI
CardPaymentEnvironment73 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment73 *-- "0..1" Check1 : Check
CardPaymentEnvironment73 *-- "0..0" StoredValueAccount1 : StoredValueAccount
CardPaymentEnvironment73 *-- "0..0" LoyaltyAccount1 : LoyaltyAccount
CardPaymentEnvironment73 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment73 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment73 *-- "0..1" CardPaymentToken4 : PaymentToken
CardPaymentEnvironment73 *-- "0..1" Cardholder14 : Cardholder
CardPaymentEnvironment73 *-- "0..1" ContentInformationType17 : ProtectedCardholderData
CardPaymentEnvironment73 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext27 recursion level 1 with max 1
CardPaymentContext27 *-- "0..1" PaymentContext26 : PaymentContext
CardPaymentContext27 *-- "0..1" SaleContext3 : SaleContext
CardPaymentContext27 *-- "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
  

ReportRequest2 members

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
%% ContentInformationType18 recursion level 0 with max 1
class ContentInformationType18{
    ContentType ContentType2Code
}
ContentInformationType18 *-- "0..1" AuthenticatedData5 : AuthenticatedData
ContentInformationType18 *-- "0..1" SignedData5 : SignedData
%% 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
%% SignedData5 recursion level 1 with max 1
class SignedData5{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData5 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData5 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData5 *-- "0..0" Signer4 : Signer
  

ContentInformationType18 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SaleToPOIReportRequestV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOIReportRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIReportRequestV01Document implements IOuterDocument. Because SaleToPOIReportRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIReportRequestV01.

classDiagram
    class IOuterRecord
    SaleToPOIReportRequestV01 --|> IOuterRecord : Implements
    SaleToPOIReportRequestV01Document --|> IOuterDocument~SaleToPOIReportRequestV01~ : Implements
    class IOuterDocument~SaleToPOIReportRequestV01~ {
        SaleToPOIReportRequestV01 Message
     }
  

Document wrapper for serialization

The only real purpose SaleToPOIReportRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.009.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIReportRequestV01.ToDocument() method. The returned SaleToPOIReportRequestV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    SaleToPOIReportRequestV01Document *-- SaleToPOIReportRequestV01 : 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.01">
    <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="_I1wqEYYCEemxIqbaFEE8-w"
  nextVersions="_GAgmcQ1VEeqjM-rxn3HuXQ"
  name="SaleToPOIReportRequestV01"
  definition="This message is a request for several kind of Report services that the Sale System (Merchant I.S.) can request to the POI system (Card Acceptor system)."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="SaleToPOIRptReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_I1wqE4YCEemxIqbaFEE8-w"
    nextVersions="_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="_vgI-odj3EeiojJsa6FYyew" />
  <messageBuildingBlock
    xmi:id="_I1wqFYYCEemxIqbaFEE8-w"
    nextVersions="_GAhNgw1VEeqjM-rxn3HuXQ"
    name="ReportRequest"
    definition="Information related to the report request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptReq"
    complexType="_NbLWAYYCEemxIqbaFEE8-w" />
  <messageBuildingBlock
    xmi:id="_I1wqF4YCEemxIqbaFEE8-w"
    nextVersions="_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="__DJZ4dtZEee9e6xduATmQg" />
  <messageDefinitionIdentifier
    businessArea="casp"
    messageFunctionality="009"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.