Iso20022

SaleToPOIServiceRequestV02

casp.001.001.02

This SaleToPOIServiceRequest message is sent by a sale system to trig a financial service on POI 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
%% SaleToPOIServiceRequestV02 recursion level 0 with max 0
SaleToPOIServiceRequestV02 *-- "1..1" Header41 : Header
SaleToPOIServiceRequestV02 *-- "1..1" ServiceRequest3 : ServiceRequest
SaleToPOIServiceRequestV02 *-- "0..1" ContentInformationType21 : 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

ServiceRequest building block

Information related to a service request. This component defines the service to be called. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ServiceRequest3 recursion level 0 with max 1
class ServiceRequest3{
    ServiceContent RetailerService2Code
}
ServiceRequest3 *-- "1..1" CardPaymentEnvironment75 : Environment
ServiceRequest3 *-- "1..1" CardPaymentContext28 : Context
ServiceRequest3 *-- "0..1" PaymentRequest2 : PaymentRequest
ServiceRequest3 *-- "0..1" ReversalRequest2 : ReversalRequest
ServiceRequest3 *-- "0..1" BalanceInquiryRequest3 : BalanceInquiryRequest
ServiceRequest3 *-- "0..1" LoyaltyRequest2 : LoyaltyRequest
ServiceRequest3 *-- "0..1" StoredValueRequest3 : StoredValueRequest
ServiceRequest3 *-- "0..1" BatchRequest2 : BatchRequest
ServiceRequest3 *-- "0..1" EnableServiceRequest2 : EnableServiceRequest
ServiceRequest3 *-- "0..1" CardAcquisitionRequest2 : CardAcquisitionRequest
ServiceRequest3 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment75 recursion level 1 with max 1
CardPaymentEnvironment75 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment75 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment75 *-- "0..1" PointOfInteraction10 : POI
CardPaymentEnvironment75 *-- "0..1" PaymentCard30 : Card
CardPaymentEnvironment75 *-- "0..1" Check1 : Check
CardPaymentEnvironment75 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment75 *-- "0..0" LoyaltyAccount2 : LoyaltyAccount
CardPaymentEnvironment75 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment75 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment75 *-- "0..1" CardPaymentToken5 : PaymentToken
CardPaymentEnvironment75 *-- "0..1" Cardholder16 : Cardholder
CardPaymentEnvironment75 *-- "0..1" ContentInformationType22 : ProtectedCardholderData
CardPaymentEnvironment75 *-- "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
%% PaymentRequest2 recursion level 1 with max 1
PaymentRequest2 *-- "0..1" CardPaymentTransaction100 : PaymentTransaction
PaymentRequest2 *-- "0..0" LoyaltyRequestData2 : LoyaltyData
%% ReversalRequest2 recursion level 1 with max 1
class ReversalRequest2{
    ReversalReason ReversalReason1Code
    ReversedAmount IsoImpliedCurrencyAndAmount
}
ReversalRequest2 *-- "0..1" CardPaymentTransaction100 : OriginalPaymentTransaction
ReversalRequest2 *-- "0..1" CustomerOrder1 : CustomerOrder
%% BalanceInquiryRequest3 recursion level 1 with max 1
BalanceInquiryRequest3 *-- "0..1" PaymentAccountRequest1 : PaymentAccountRequest
BalanceInquiryRequest3 *-- "0..1" LoyaltyAccountRequest2 : LoyaltyAccountRequest
BalanceInquiryRequest3 *-- "0..1" StoredValueRequest3 : StoredValueAccountRequest
%% LoyaltyRequest2 recursion level 1 with max 1
LoyaltyRequest2 *-- "0..1" CustomerOrder1 : CustomerOrder
LoyaltyRequest2 *-- "1..1" LoyaltyTransaction2 : Transaction
LoyaltyRequest2 *-- "0..0" LoyaltyRequestData2 : Data
%% StoredValueRequest3 recursion level 1 with max 1
StoredValueRequest3 *-- "1..0" StoredValueData3 : Data
%% BatchRequest2 recursion level 1 with max 1
class BatchRequest2{
    RemoveAllFlag IsoTrueFalseIndicator
}
BatchRequest2 *-- "0..0" ITransactionToPerform2Choice : TransactionToPerform
%% EnableServiceRequest2 recursion level 1 with max 1
class EnableServiceRequest2{
    TransactionAction TransactionAction1Code
    ServicesEnabled RetailerService2Code
}
EnableServiceRequest2 *-- "0..1" ActionMessage7 : DisplayOutput
%% CardAcquisitionRequest2 recursion level 1 with max 1
class CardAcquisitionRequest2{
    AllowedPaymentBrand IsoMax35Text
    AllowedLoyaltyBrand IsoMax35Text
    ForceCustomerSelectionFlag IsoTrueFalseIndicator
    TotalAmount IsoImpliedCurrencyAndAmount
    PaymentType CardPaymentServiceType13Code
    CashBackFlag IsoTrueFalseIndicator
    SaleToPOIData IsoMax70Text
    SaleToAcquirerData IsoMax70Text
    SaleToIssuerData IsoMax70Text
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

ServiceRequest3 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment75 - 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. RetailerService2Code - Required 1..1
PaymentRequest Content of the payment request. PaymentRequest2 - Optional 0..1
ReversalRequest Content of the reversal request. ReversalRequest2 - Optional 0..1
BalanceInquiryRequest Content of a Balance Inquiry Request. BalanceInquiryRequest3 - Optional 0..1
LoyaltyRequest Content of the Loyalty Request. LoyaltyRequest2 - Optional 0..1
StoredValueRequest Content of a Stored Value Request. StoredValueRequest3 - Optional 0..1
BatchRequest Content of the Batch Request. BatchRequest2 - Optional 0..1
EnableServiceRequest Content of the Enable Service Request. EnableServiceRequest2 - Optional 0..1
CardAcquisitionRequest Content of the Card Acquisition Request. CardAcquisitionRequest2 - 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
%% ContentInformationType21 recursion level 0 with max 1
class ContentInformationType21{
    ContentType ContentType2Code
}
ContentInformationType21 *-- "0..1" AuthenticatedData6 : AuthenticatedData
ContentInformationType21 *-- "0..1" SignedData5 : SignedData
%% AuthenticatedData6 recursion level 1 with max 1
class AuthenticatedData6{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData6 *-- "1..0" IRecipient8Choice : Recipient
AuthenticatedData6 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData6 *-- "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

ContentInformationType21 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). AuthenticatedData6 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData5 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SaleToPOIServiceRequestV02 --|> IOuterRecord : Implements
    SaleToPOIServiceRequestV02Document --|> IOuterDocument~SaleToPOIServiceRequestV02~ : Implements
    class IOuterDocument~SaleToPOIServiceRequestV02~ {
        SaleToPOIServiceRequestV02 Message
     }

Document wrapper for serialization

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

classDiagram
    SaleToPOIServiceRequestV02Document *-- SaleToPOIServiceRequestV02 : 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.001.001.02">
    <SaleToPOISvcReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <SvcReq>
            <!-- ServiceRequest inner content -->
        </SvcReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </SaleToPOISvcReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_cFuKEQ1VEeqjM-rxn3HuXQ"
  nextVersions="_3x9W0S5LEeunNvJlR_vCbg"
  previousVersion="_dTGYUYX_EemxIqbaFEE8-w"
  name="SaleToPOIServiceRequestV02"
  definition="This SaleToPOIServiceRequest message is sent by a sale system to trig a financial service on POI system."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="SaleToPOISvcReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_cFuKEw1VEeqjM-rxn3HuXQ"
    nextVersions="_3x9W0y5LEeunNvJlR_vCbg"
    previousVersion="_dTGYU4X_EemxIqbaFEE8-w"
    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="_cFuKFQ1VEeqjM-rxn3HuXQ"
    nextVersions="_3x9W1S5LEeunNvJlR_vCbg"
    previousVersion="_dTGYVYX_EemxIqbaFEE8-w"
    name="ServiceRequest"
    definition="Information related to a service request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SvcReq"
    complexType="_jYNgQQ1VEeqjM-rxn3HuXQ" />
  <messageBuildingBlock
    xmi:id="_cFuKFw1VEeqjM-rxn3HuXQ"
    nextVersions="_3x9W1y5LEeunNvJlR_vCbg"
    previousVersion="_dTGYV4X_EemxIqbaFEE8-w"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_gkSEMQuhEeqw5uEXxQ9H4g" />
  <messageDefinitionIdentifier
    businessArea="casp"
    messageFunctionality="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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