Iso20022

SaleToPOIReportResponseV05

casp.010.001.05

This SaleToPOIReportResponse message is sent by a POI to provide the report previously expected by a sale 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
%% SaleToPOIReportResponseV05 recursion level 0 with max 0
SaleToPOIReportResponseV05 *-- "1..1" Header41 : Header
SaleToPOIReportResponseV05 *-- "1..1" ReportResponse6 : ReportResponse
SaleToPOIReportResponseV05 *-- "0..1" ContentInformationType33 : 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

ReportResponse building block

Information related to the response of a 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
%% ReportResponse6 recursion level 0 with max 1
class ReportResponse6{
    ServiceContent RetailerService7Code
}
ReportResponse6 *-- "1..1" CardPaymentEnvironment79 : Environment
ReportResponse6 *-- "1..1" CardPaymentContext30 : Context
ReportResponse6 *-- "0..1" ReportTransactionResponse5 : ReportTransactionResponse
ReportResponse6 *-- "0..1" ReportGetTotalsResponse1 : ReportGetTotalsResponse
ReportResponse6 *-- "1..1" ResponseType11 : Response
ReportResponse6 *-- "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
%% ReportTransactionResponse5 recursion level 1 with max 1
class ReportTransactionResponse5{
    ReportFullSize IsoPositiveNumber
    BlockStart IsoPositiveNumber
    BlockStop IsoPositiveNumber
}
ReportTransactionResponse5 *-- "0..0" ServiceResponse7 : TransactionReport
%% ReportGetTotalsResponse1 recursion level 1 with max 1
class ReportGetTotalsResponse1{
    POIReconciliationIdentification IsoMax35Text
}
ReportGetTotalsResponse1 *-- "0..0" TransactionTotalsSet1 : TransactionTotalsSet
%% ResponseType11 recursion level 1 with max 1
class ResponseType11{
    Response Response11Code
    ResponseReason RetailerResultDetail1Code
    AdditionalResponseInformation IsoMax140Text
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

ReportResponse6 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. RetailerService7Code - Required 1..1
ReportTransactionResponse Content of the Transaction Report Response message. ReportTransactionResponse5 - Optional 0..1
ReportGetTotalsResponse Content of the Get Totals Response message. ReportGetTotalsResponse1 - Optional 0..1
Response Result of the processing of the request. ResponseType11 - 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 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
%% ContentInformationType33 recursion level 0 with max 1
class ContentInformationType33{
    ContentType ContentType2Code
}
ContentInformationType33 *-- "0..1" AuthenticatedData9 : AuthenticatedData
ContentInformationType33 *-- "0..1" SignedData8 : SignedData
%% 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
%% SignedData8 recursion level 1 with max 1
class SignedData8{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData8 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData8 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData8 *-- "0..0" Signer7 : Signer

ContentInformationType33 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 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData8 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SaleToPOIReportResponseV05 --|> IOuterRecord : Implements
    SaleToPOIReportResponseV05Document --|> IOuterDocument~SaleToPOIReportResponseV05~ : Implements
    class IOuterDocument~SaleToPOIReportResponseV05~ {
        SaleToPOIReportResponseV05 Message
     }

Document wrapper for serialization

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

classDiagram
    SaleToPOIReportResponseV05Document *-- SaleToPOIReportResponseV05 : 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.010.001.05">
    <SaleToPOIRptRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <RptRspn>
            <!-- ReportResponse inner content -->
        </RptRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </SaleToPOIRptRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DGT9UXPFEe2pK6udhxEaHA"
  previousVersion="_wMaG8U0-Eeybj420QgWBkA"
  name="SaleToPOIReportResponseV05"
  definition="This SaleToPOIReportResponse message is sent by a POI to provide the report previously expected by a sale system."
  registrationStatus="Registered"
  messageSet="_O55JAIX9EemxIqbaFEE8-w"
  xmlTag="SaleToPOIRptRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_DGT9U3PFEe2pK6udhxEaHA"
    previousVersion="_wMaG800-Eeybj420QgWBkA"
    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="_DGT9VXPFEe2pK6udhxEaHA"
    previousVersion="_wMaG9U0-Eeybj420QgWBkA"
    name="ReportResponse"
    definition="Information related to the response of a report request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptRspn"
    complexType="_nAqyUXJFEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_DGT9V3PFEe2pK6udhxEaHA"
    previousVersion="_wMaG900-Eeybj420QgWBkA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_sqC0wXDIEe2MCaKO5AtGsA" />
  <messageDefinitionIdentifier
    businessArea="casp"
    messageFunctionality="010"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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