SaleToPOIDeviceRequestV01

casp.016.001.01

This message is a request for several kind of device services exchanged between the Sale System (Merchant I.S.) and 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
%% SaleToPOIDeviceRequestV01 recursion level 0 with max 0
SaleToPOIDeviceRequestV01 *-- "1..1" Header37 : Header
SaleToPOIDeviceRequestV01 *-- "1..1" DeviceRequest2 : DeviceRequest
SaleToPOIDeviceRequestV01 *-- "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

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
%% DeviceRequest2 recursion level 0 with max 1
class DeviceRequest2{
    ServiceContent RetailerService8Code
}
DeviceRequest2 *-- "1..1" CardPaymentEnvironment73 : Environment
DeviceRequest2 *-- "1..1" CardPaymentContext27 : Context
DeviceRequest2 *-- "0..1" DeviceDisplayRequest1 : DisplayRequest
DeviceRequest2 *-- "0..1" DeviceInputRequest1 : InputRequest
DeviceRequest2 *-- "0..1" DevicePrintRequest1 : PrintRequest
DeviceRequest2 *-- "0..1" DevicePlaySoundRequest1 : PlaySoundRequest
DeviceRequest2 *-- "0..1" DeviceSecureInputRequest1 : SecureInputRequest
DeviceRequest2 *-- "0..1" DeviceInitialisationCardReaderRequest1 : InitialisationCardReaderRequest
DeviceRequest2 *-- "0..1" DeviceSendApplicationProtocolDataUnitCardReaderRequest1 : CardReaderAPDURequest
DeviceRequest2 *-- "0..1" DevicePoweroffCardReaderRequest1 : PowerOffCardReaderRequest
DeviceRequest2 *-- "0..1" DeviceTransmitMessageRequest1 : TransmissionRequest
DeviceRequest2 *-- "0..1" DeviceInputNotification1 : InputNotification
DeviceRequest2 *-- "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
%% DeviceDisplayRequest1 recursion level 1 with max 1
DeviceDisplayRequest1 *-- "1..0" ActionMessage6 : DisplayOutput
%% DeviceInputRequest1 recursion level 1 with max 1
DeviceInputRequest1 *-- "0..1" ActionMessage6 : DisplayOutput
DeviceInputRequest1 *-- "1..1" InputData1 : InputData
%% DevicePrintRequest1 recursion level 1 with max 1
class DevicePrintRequest1{
    DocumentQualifier DocumentType7Code
    ResponseMode ResponseMode1Code
    IntegratedPrintFlag IsoTrueFalseIndicator
    RequiredSignatureFlag IsoTrueFalseIndicator
}
DevicePrintRequest1 *-- "1..1" ActionMessage6 : OutputContent
%% DevicePlaySoundRequest1 recursion level 1 with max 1
class DevicePlaySoundRequest1{
    ResponseMode ResponseMode1Code
    SoundAction SoundAction1Code
    SoundVolume IsoPercentageRate
}
DevicePlaySoundRequest1 *-- "0..1" SoundContent1 : SoundContent
%% DeviceSecureInputRequest1 recursion level 1 with max 1
class DeviceSecureInputRequest1{
    PINRequestType PINRequestType1Code
    PINVerificationMethod IsoMax35Text
    MaximumWaitingTime IsoNumber
    BeepKeyFlag IsoTrueFalseIndicator
}
DeviceSecureInputRequest1 *-- "0..1" OnLinePIN6 : CardholderPIN
%% DeviceInitialisationCardReaderRequest1 recursion level 1 with max 1
class DeviceInitialisationCardReaderRequest1{
    WarmResetFlag IsoTrueFalseIndicator
    ForceEntryMode CardDataReading6Code
    LeaveCardFlag IsoTrueFalseIndicator
    MaximumWaitingTime IsoNumber
}
DeviceInitialisationCardReaderRequest1 *-- "0..1" ActionMessage6 : DisplayOutput
%% DeviceSendApplicationProtocolDataUnitCardReaderRequest1 recursion level 1 with max 1
class DeviceSendApplicationProtocolDataUnitCardReaderRequest1{
    Class IsoMin1Max256Binary
    Instruction IsoMin1Max256Binary
    Parameter1 IsoMin1Max256Binary
    Parameter2 IsoMin1Max256Binary
    Data IsoMin1Max256Binary
    ExpectedLength IsoMin1Max256Binary
}
%% DevicePoweroffCardReaderRequest1 recursion level 1 with max 1
class DevicePoweroffCardReaderRequest1{
    PowerOffMaximumWaitingTime IsoNumber
}
DevicePoweroffCardReaderRequest1 *-- "0..1" ActionMessage6 : DisplayOutput
%% DeviceTransmitMessageRequest1 recursion level 1 with max 1
class DeviceTransmitMessageRequest1{
    MaximumTransmissionTime IsoNumber
    MaximumWaitingTime IsoNumber
    MessageToSend IsoMax100KBinary
}
DeviceTransmitMessageRequest1 *-- "1..1" NetworkParameters5 : DestinationAddress
%% DeviceInputNotification1 recursion level 1 with max 1
class DeviceInputNotification1{
    ExchangeIdentification IsoMax35Text
}
DeviceInputNotification1 *-- "1..1" ActionMessage6 : OutputContent
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SaleToPOIDeviceRequestV01 --|> IOuterRecord : Implements
    SaleToPOIDeviceRequestV01Document --|> IOuterDocument~SaleToPOIDeviceRequestV01~ : Implements
    class IOuterDocument~SaleToPOIDeviceRequestV01~ {
        SaleToPOIDeviceRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SaleToPOIDeviceRequestV01Document *-- SaleToPOIDeviceRequestV01 : 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.01">
    <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="_OUYZcYYDEemxIqbaFEE8-w"
  nextVersions="_A_43IQ1TEeqjM-rxn3HuXQ"
  name="SaleToPOIDeviceRequestV01"
  definition="This message is a request for several kind of device services exchanged between the Sale System (Merchant I.S.) and the POI system (Card Acceptor system)."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="SaleToPOIDvcReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_OUYZc4YDEemxIqbaFEE8-w"
    nextVersions="_A_43Iw1TEeqjM-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="_OUYZdYYDEemxIqbaFEE8-w"
    nextVersions="_A_43JQ1TEeqjM-rxn3HuXQ"
    name="DeviceRequest"
    definition="Information related to a device request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DvcReq"
    complexType="_RS_foYYDEemxIqbaFEE8-w" />
  <messageBuildingBlock
    xmi:id="_OUYZd4YDEemxIqbaFEE8-w"
    nextVersions="_A_43Jw1TEeqjM-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="016"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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