casp.016.001.02
The SaleTOPOIDeviceRequest message is sent by the sale system to POI system to request a device service.
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
%% SaleToPOIDeviceRequestV02 recursion level 0 with max 0
SaleToPOIDeviceRequestV02 *-- "1..1" Header41 : Header
SaleToPOIDeviceRequestV02 *-- "1..1" DeviceRequest3 : DeviceRequest
SaleToPOIDeviceRequestV02 *-- "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 |
DeviceRequest building block
Information related to a device request. This component define the environment, the context and the services to be used with this message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% DeviceRequest3 recursion level 0 with max 1
class DeviceRequest3{
ServiceContent RetailerService8Code
}
DeviceRequest3 *-- "0..1" CardPaymentEnvironment75 : Environment
DeviceRequest3 *-- "0..1" CardPaymentContext28 : Context
DeviceRequest3 *-- "0..1" DeviceDisplayRequest2 : DisplayRequest
DeviceRequest3 *-- "0..1" DeviceInputRequest2 : InputRequest
DeviceRequest3 *-- "0..1" DevicePrintRequest2 : PrintRequest
DeviceRequest3 *-- "0..1" DevicePlaySoundRequest1 : PlaySoundRequest
DeviceRequest3 *-- "0..1" DeviceSecureInputRequest2 : SecureInputRequest
DeviceRequest3 *-- "0..1" DeviceInitialisationCardReaderRequest2 : InitialisationCardReaderRequest
DeviceRequest3 *-- "0..1" DeviceSendApplicationProtocolDataUnitCardReaderRequest1 : CardReaderAPDURequest
DeviceRequest3 *-- "0..1" DevicePoweroffCardReaderRequest2 : PowerOffCardReaderRequest
DeviceRequest3 *-- "0..1" DeviceTransmitMessageRequest2 : TransmissionRequest
DeviceRequest3 *-- "0..1" DeviceInputNotification2 : InputNotification
DeviceRequest3 *-- "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
%% DeviceDisplayRequest2 recursion level 1 with max 1
DeviceDisplayRequest2 *-- "1..0" ActionMessage7 : DisplayOutput
%% DeviceInputRequest2 recursion level 1 with max 1
DeviceInputRequest2 *-- "0..1" ActionMessage7 : DisplayOutput
DeviceInputRequest2 *-- "1..1" InputData2 : InputData
%% DevicePrintRequest2 recursion level 1 with max 1
class DevicePrintRequest2{
DocumentQualifier DocumentType7Code
ResponseMode ResponseMode1Code
IntegratedPrintFlag IsoTrueFalseIndicator
RequiredSignatureFlag IsoTrueFalseIndicator
}
DevicePrintRequest2 *-- "1..1" ActionMessage7 : OutputContent
%% DevicePlaySoundRequest1 recursion level 1 with max 1
class DevicePlaySoundRequest1{
ResponseMode ResponseMode1Code
SoundAction SoundAction1Code
SoundVolume IsoPercentageRate
}
DevicePlaySoundRequest1 *-- "0..1" SoundContent1 : SoundContent
%% DeviceSecureInputRequest2 recursion level 1 with max 1
class DeviceSecureInputRequest2{
PINRequestType PINRequestType1Code
PINVerificationMethod IsoMax35Text
MaximumWaitingTime IsoNumber
BeepKeyFlag IsoTrueFalseIndicator
}
DeviceSecureInputRequest2 *-- "0..1" OnLinePIN7 : CardholderPIN
%% DeviceInitialisationCardReaderRequest2 recursion level 1 with max 1
class DeviceInitialisationCardReaderRequest2{
WarmResetFlag IsoTrueFalseIndicator
ForceEntryMode CardDataReading8Code
LeaveCardFlag IsoTrueFalseIndicator
MaximumWaitingTime IsoNumber
}
DeviceInitialisationCardReaderRequest2 *-- "0..1" ActionMessage7 : DisplayOutput
%% DeviceSendApplicationProtocolDataUnitCardReaderRequest1 recursion level 1 with max 1
class DeviceSendApplicationProtocolDataUnitCardReaderRequest1{
Class IsoMin1Max256Binary
Instruction IsoMin1Max256Binary
Parameter1 IsoMin1Max256Binary
Parameter2 IsoMin1Max256Binary
Data IsoMin1Max256Binary
ExpectedLength IsoMin1Max256Binary
}
%% DevicePoweroffCardReaderRequest2 recursion level 1 with max 1
class DevicePoweroffCardReaderRequest2{
PowerOffMaximumWaitingTime IsoNumber
}
DevicePoweroffCardReaderRequest2 *-- "0..1" ActionMessage7 : DisplayOutput
%% DeviceTransmitMessageRequest2 recursion level 1 with max 1
class DeviceTransmitMessageRequest2{
MaximumTransmissionTime IsoNumber
MaximumWaitingTime IsoNumber
MessageToSend IsoMax100KBinary
}
DeviceTransmitMessageRequest2 *-- "1..1" NetworkParameters7 : DestinationAddress
%% DeviceInputNotification2 recursion level 1 with max 1
class DeviceInputNotification2{
ExchangeIdentification IsoMax35Text
}
DeviceInputNotification2 *-- "1..1" ActionMessage7 : OutputContent
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
DeviceRequest3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment75 - Optional 0..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext28 - Optional 0..1 |
| ServiceContent | Define the type of service requested. | RetailerService8Code - Required 1..1 |
| DisplayRequest | Content of the Display Request message. | DeviceDisplayRequest2 - Optional 0..1 |
| InputRequest | Content of the Input Request message. | DeviceInputRequest2 - Optional 0..1 |
| PrintRequest | Content of the Print Request message. | DevicePrintRequest2 - Optional 0..1 |
| PlaySoundRequest | Content of the Sound Request message. | DevicePlaySoundRequest1 - Optional 0..1 |
| SecureInputRequest | Request a secure input for a PIN. | DeviceSecureInputRequest2 - Optional 0..1 |
| InitialisationCardReaderRequest | A service to send parameters to Card Reader to initialize a new communication with a card. | DeviceInitialisationCardReaderRequest2 - Optional 0..1 |
| CardReaderAPDURequest | Content of the APDU (Application Protocol Data Unit) to send to the Card. | DeviceSendApplicationProtocolDataUnitCardReaderRequest1 - Optional 0..1 |
| PowerOffCardReaderRequest | Content of the Power Off Card Reader Request message. | DevicePoweroffCardReaderRequest2 - Optional 0..1 |
| TransmissionRequest | Content of the Request message to transmit. | DeviceTransmitMessageRequest2 - Optional 0..1 |
| InputNotification | Content of the Input notification message. | DeviceInputNotification2 - 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 SaleToPOIDeviceRequestV02 implementation follows a specific implementaiton pattern. First of all, SaleToPOIDeviceRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIDeviceRequestV02Document implements IOuterDocument. Because SaleToPOIDeviceRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIDeviceRequestV02.
classDiagram
class IOuterRecord
SaleToPOIDeviceRequestV02 --|> IOuterRecord : Implements
SaleToPOIDeviceRequestV02Document --|> IOuterDocument~SaleToPOIDeviceRequestV02~ : Implements
class IOuterDocument~SaleToPOIDeviceRequestV02~ {
SaleToPOIDeviceRequestV02 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIDeviceRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.016.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIDeviceRequestV02.ToDocument() method. The returned SaleToPOIDeviceRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIDeviceRequestV02Document *-- SaleToPOIDeviceRequestV02 : 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.016.001.02">
<SaleToPOIDvcReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<DvcReq>
<!-- DeviceRequest inner content -->
</DvcReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIDvcReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_A_43IQ1TEeqjM-rxn3HuXQ"
nextVersions="_cypGIS5KEeunNvJlR_vCbg"
previousVersion="_OUYZcYYDEemxIqbaFEE8-w"
name="SaleToPOIDeviceRequestV02"
definition="The SaleTOPOIDeviceRequest message is sent by the sale system to POI system to request a device service."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOIDvcReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_A_43Iw1TEeqjM-rxn3HuXQ"
nextVersions="_cypGIy5KEeunNvJlR_vCbg"
previousVersion="_OUYZc4YDEemxIqbaFEE8-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="_A_43JQ1TEeqjM-rxn3HuXQ"
nextVersions="_cypGJS5KEeunNvJlR_vCbg"
previousVersion="_OUYZdYYDEemxIqbaFEE8-w"
name="DeviceRequest"
definition="Information related to a device request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="DvcReq"
complexType="_gvdHYQ0rEeqUVL7sB4m7NA" />
<messageBuildingBlock
xmi:id="_A_43Jw1TEeqjM-rxn3HuXQ"
nextVersions="_cypGJy5KEeunNvJlR_vCbg"
previousVersion="_OUYZd4YDEemxIqbaFEE8-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="016"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.