SaleToPOIServiceRequestV03

casp.001.001.03

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
%% SaleToPOIServiceRequestV03 recursion level 0 with max 0
SaleToPOIServiceRequestV03 *-- "1..1" Header41 : Header
SaleToPOIServiceRequestV03 *-- "1..1" ServiceRequest4 : ServiceRequest
SaleToPOIServiceRequestV03 *-- "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

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
%% ServiceRequest4 recursion level 0 with max 1
class ServiceRequest4{
    ServiceContent RetailerService2Code
}
ServiceRequest4 *-- "1..1" CardPaymentEnvironment77 : Environment
ServiceRequest4 *-- "1..1" CardPaymentContext28 : Context
ServiceRequest4 *-- "0..1" PaymentRequest3 : PaymentRequest
ServiceRequest4 *-- "0..1" ReversalRequest3 : ReversalRequest
ServiceRequest4 *-- "0..1" BalanceInquiryRequest4 : BalanceInquiryRequest
ServiceRequest4 *-- "0..1" LoyaltyRequest3 : LoyaltyRequest
ServiceRequest4 *-- "0..1" StoredValueRequest4 : StoredValueRequest
ServiceRequest4 *-- "0..1" BatchRequest3 : BatchRequest
ServiceRequest4 *-- "0..1" EnableServiceRequest3 : EnableServiceRequest
ServiceRequest4 *-- "0..1" CardAcquisitionRequest2 : CardAcquisitionRequest
ServiceRequest4 *-- "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
%% PaymentRequest3 recursion level 1 with max 1
PaymentRequest3 *-- "0..1" CardPaymentTransaction110 : PaymentTransaction
PaymentRequest3 *-- "0..0" LoyaltyRequestData2 : LoyaltyData
%% ReversalRequest3 recursion level 1 with max 1
class ReversalRequest3{
    ReversalReason ReversalReason1Code
    ReversedAmount IsoImpliedCurrencyAndAmount
}
ReversalRequest3 *-- "0..1" CardPaymentTransaction110 : ReversalTransaction
ReversalRequest3 *-- "0..0" LoyaltyRequestData2 : LoyaltyData
ReversalRequest3 *-- "0..1" CustomerOrder1 : CustomerOrder
%% BalanceInquiryRequest4 recursion level 1 with max 1
BalanceInquiryRequest4 *-- "0..1" PaymentAccountRequest1 : PaymentAccountRequest
BalanceInquiryRequest4 *-- "0..1" LoyaltyAccountRequest2 : LoyaltyAccountRequest
BalanceInquiryRequest4 *-- "0..1" StoredValueRequest4 : StoredValueAccountRequest
%% LoyaltyRequest3 recursion level 1 with max 1
LoyaltyRequest3 *-- "0..1" CustomerOrder1 : CustomerOrder
LoyaltyRequest3 *-- "1..1" LoyaltyTransaction3 : Transaction
LoyaltyRequest3 *-- "0..0" LoyaltyRequestData2 : Data
%% StoredValueRequest4 recursion level 1 with max 1
StoredValueRequest4 *-- "1..0" StoredValueData4 : Data
%% BatchRequest3 recursion level 1 with max 1
class BatchRequest3{
    RemoveAllFlag IsoTrueFalseIndicator
}
BatchRequest3 *-- "0..0" ITransactionToPerform3Choice : TransactionToPerform
%% EnableServiceRequest3 recursion level 1 with max 1
class EnableServiceRequest3{
    TransactionAction TransactionAction1Code
    ServicesEnabled RetailerService2Code
}
EnableServiceRequest3 *-- "0..1" ActionMessage8 : 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
  

ServiceRequest4 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
%% 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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SaleToPOIServiceRequestV03 --|> IOuterRecord : Implements
    SaleToPOIServiceRequestV03Document --|> IOuterDocument~SaleToPOIServiceRequestV03~ : Implements
    class IOuterDocument~SaleToPOIServiceRequestV03~ {
        SaleToPOIServiceRequestV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SaleToPOIServiceRequestV03Document *-- SaleToPOIServiceRequestV03 : 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.03">
    <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="_3x9W0S5LEeunNvJlR_vCbg"
  nextVersions="_n5ruoU31Eey_VecAUE-C9Q"
  previousVersion="_cFuKEQ1VEeqjM-rxn3HuXQ"
  name="SaleToPOIServiceRequestV03"
  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="_3x9W0y5LEeunNvJlR_vCbg"
    nextVersions="_n5ruo031Eey_VecAUE-C9Q"
    previousVersion="_cFuKEw1VEeqjM-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="_3x9W1S5LEeunNvJlR_vCbg"
    nextVersions="_n5rupU31Eey_VecAUE-C9Q"
    previousVersion="_cFuKFQ1VEeqjM-rxn3HuXQ"
    name="ServiceRequest"
    definition="Information related to a service request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SvcReq"
    complexType="_vzaL4S5LEeunNvJlR_vCbg" />
  <messageBuildingBlock
    xmi:id="_3x9W1y5LEeunNvJlR_vCbg"
    nextVersions="_n5rup031Eey_VecAUE-C9Q"
    previousVersion="_cFuKFw1VEeqjM-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="001"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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