casp.005.001.01
This message is a request for several kind of Administrative services related to Session Management ’ that the Sale System (Merchant I.S.) can send 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
%% SaleToPOISessionManagementRequestV01 recursion level 0 with max 0
SaleToPOISessionManagementRequestV01 *-- "1..1" Header37 : Header
SaleToPOISessionManagementRequestV01 *-- "1..1" SessionManagementRequest2 : SessionManagementRequest
SaleToPOISessionManagementRequestV01 *-- "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
| 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. | GenericIdentification171 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification171 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability6 - 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
%% SessionManagementRequest2 recursion level 0 with max 1
class SessionManagementRequest2{
ServiceContent RetailerService4Code
}
SessionManagementRequest2 *-- "1..1" CardPaymentEnvironment73 : Environment
SessionManagementRequest2 *-- "1..1" CardPaymentContext27 : Context
SessionManagementRequest2 *-- "0..1" LoginRequest1 : LoginRequest
SessionManagementRequest2 *-- "0..1" LogoutRequest1 : LogoutRequest
SessionManagementRequest2 *-- "0..1" DiagnosisRequest1 : DiagnosisRequest
SessionManagementRequest2 *-- "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
%% LoginRequest1 recursion level 1 with max 1
class LoginRequest1{
LoginDateTime IsoISODateTime
TrainingModeFlag IsoTrueFalseIndicator
CashierIdentification IsoMax35Text
CashierLanguage LanguageCode
ShiftNumber IsoMax2NumericText
TokenRequestedType SaleTokenScope1Code
CustomerOrderRequest CustomerOrderRequest1Code
TotalsGroupIdentification IsoMax35Text
}
LoginRequest1 *-- "1..0" PointOfInteractionComponent9 : SaleSoftware
LoginRequest1 *-- "0..1" SaleTerminalData1 : SaleTerminalData
LoginRequest1 *-- "0..1" PointOfInteractionComponentIdentification1 : POIIdentification
%% 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
SessionManagementRequest2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment73 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext27 - Required 1..1 |
| ServiceContent | Define the type of service requested. | RetailerService4Code - Required 1..1 |
| LoginRequest | Content of the Login Request message. | LoginRequest1 - 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
%% 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData5 - 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 SaleToPOISessionManagementRequestV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOISessionManagementRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOISessionManagementRequestV01Document implements IOuterDocument. Because SaleToPOISessionManagementRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOISessionManagementRequestV01.
classDiagram
class IOuterRecord
SaleToPOISessionManagementRequestV01 --|> IOuterRecord : Implements
SaleToPOISessionManagementRequestV01Document --|> IOuterDocument~SaleToPOISessionManagementRequestV01~ : Implements
class IOuterDocument~SaleToPOISessionManagementRequestV01~ {
SaleToPOISessionManagementRequestV01 Message
}
Document wrapper for serialization
The only real purpose SaleToPOISessionManagementRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.005.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOISessionManagementRequestV01.ToDocument() method. The returned SaleToPOISessionManagementRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOISessionManagementRequestV01Document *-- SaleToPOISessionManagementRequestV01 : 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.01">
<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="__7ONcYYAEemxIqbaFEE8-w"
nextVersions="_-hNt4Q1VEeqjM-rxn3HuXQ"
name="SaleToPOISessionManagementRequestV01"
definition="This message is a request for several kind of Administrative services related to Session Management ' that the Sale System (Merchant I.S.) can send to the POI system (Card Acceptor system)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOISsnMgmtReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="__7ONc4YAEemxIqbaFEE8-w"
nextVersions="_-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="_vgI-odj3EeiojJsa6FYyew" />
<messageBuildingBlock
xmi:id="__7ONdYYAEemxIqbaFEE8-w"
nextVersions="_-hNt5Q1VEeqjM-rxn3HuXQ"
name="SessionManagementRequest"
definition="Information related to the session management request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SsnMgmtReq"
complexType="_C8Um8YYBEemxIqbaFEE8-w" />
<messageBuildingBlock
xmi:id="__7ONd4YAEemxIqbaFEE8-w"
nextVersions="_-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="__DJZ4dtZEee9e6xduATmQg" />
<messageDefinitionIdentifier
businessArea="casp"
messageFunctionality="005"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.