Iso20022

SaleToPOISessionManagementRequestV03

casp.005.001.03

The SaleToPOISessionManagementRequest message is sent by a sale system to select an administrative service related to session management.

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
%% SaleToPOISessionManagementRequestV03 recursion level 0 with max 0
SaleToPOISessionManagementRequestV03 *-- "1..1" Header41 : Header
SaleToPOISessionManagementRequestV03 *-- "1..1" SessionManagementRequest4 : SessionManagementRequest
SaleToPOISessionManagementRequestV03 *-- "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

SessionManagementRequest building block

Information related to the session management request. This component define the type of Session management service to be used with this message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SessionManagementRequest4 recursion level 0 with max 1
class SessionManagementRequest4{
    ServiceContent RetailerService4Code
}
SessionManagementRequest4 *-- "1..1" CardPaymentEnvironment77 : Environment
SessionManagementRequest4 *-- "1..1" CardPaymentContext28 : Context
SessionManagementRequest4 *-- "0..1" LoginRequest3 : LoginRequest
SessionManagementRequest4 *-- "0..1" LogoutRequest1 : LogoutRequest
SessionManagementRequest4 *-- "0..1" DiagnosisRequest1 : DiagnosisRequest
SessionManagementRequest4 *-- "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
%% LoginRequest3 recursion level 1 with max 1
class LoginRequest3{
    LoginDateTime IsoISODateTime
    TrainingModeFlag IsoTrueFalseIndicator
    CashierIdentification IsoMax35Text
    CashierLanguage LanguageCode
    ShiftNumber IsoMax2NumericText
    TokenRequestedType SaleTokenScope1Code
    CustomerOrderRequest CustomerOrderRequest1Code
    TotalsGroupIdentification IsoMax35Text
}
LoginRequest3 *-- "1..0" PointOfInteractionComponent11 : SaleSoftware
LoginRequest3 *-- "0..1" SaleTerminalData1 : SaleTerminalData
LoginRequest3 *-- "0..1" PointOfInteractionComponentIdentification2 : POIIdentification
LoginRequest3 *-- "0..1" ActionMessage8 : OutputDisplay
%% LogoutRequest1 recursion level 1 with max 1
class LogoutRequest1{
    MaintenanceAllowed IsoTrueFalseIndicator
}
%% DiagnosisRequest1 recursion level 1 with max 1
class DiagnosisRequest1{
    HostDiagnosisFlag IsoTrueFalseIndicator
    AcquirerIdentification IsoMax35Text
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

SessionManagementRequest4 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. RetailerService4Code - Required 1..1
LoginRequest Content of the Login Request message. LoginRequest3 - Optional 0..1
LogoutRequest Content of the Logout Request message. LogoutRequest1 - Optional 0..1
DiagnosisRequest Content of the Diagnosis Request message. DiagnosisRequest1 - 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 SaleToPOISessionManagementRequestV03 implementation follows a specific implementaiton pattern. First of all, SaleToPOISessionManagementRequestV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOISessionManagementRequestV03Document implements IOuterDocument. Because SaleToPOISessionManagementRequestV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOISessionManagementRequestV03.

classDiagram
    class IOuterRecord
    SaleToPOISessionManagementRequestV03 --|> IOuterRecord : Implements
    SaleToPOISessionManagementRequestV03Document --|> IOuterDocument~SaleToPOISessionManagementRequestV03~ : Implements
    class IOuterDocument~SaleToPOISessionManagementRequestV03~ {
        SaleToPOISessionManagementRequestV03 Message
     }

Document wrapper for serialization

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

classDiagram
    SaleToPOISessionManagementRequestV03Document *-- SaleToPOISessionManagementRequestV03 : 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.005.001.03">
    <SaleToPOISsnMgmtReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <SsnMgmtReq>
            <!-- SessionManagementRequest inner content -->
        </SsnMgmtReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </SaleToPOISsnMgmtReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GECVUS5MEeunNvJlR_vCbg"
  nextVersions="_UxeqcU7AEeyGi9JAv6wq7Q"
  previousVersion="_-hNt4Q1VEeqjM-rxn3HuXQ"
  name="SaleToPOISessionManagementRequestV03"
  definition="The SaleToPOISessionManagementRequest message is sent by a sale system to select an administrative service related to session management."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="SaleToPOISsnMgmtReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_GECVUy5MEeunNvJlR_vCbg"
    nextVersions="_Uxeqc07AEeyGi9JAv6wq7Q"
    previousVersion="_-hNt4w1VEeqjM-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="_GECVVS5MEeunNvJlR_vCbg"
    nextVersions="_UxeqdU7AEeyGi9JAv6wq7Q"
    previousVersion="_-hNt5Q1VEeqjM-rxn3HuXQ"
    name="SessionManagementRequest"
    definition="Information related to the session management request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SsnMgmtReq"
    complexType="_AnqMMS5MEeunNvJlR_vCbg" />
  <messageBuildingBlock
    xmi:id="_GECVVy5MEeunNvJlR_vCbg"
    nextVersions="_Uxeqd07AEeyGi9JAv6wq7Q"
    previousVersion="_-hNt5w1VEeqjM-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="005"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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