SaleToPOIDeviceResponseV04

casp.017.001.04

The SaleToPOIDeviceResponse message is sent by a POI System to sale system to provide result of a device request.

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
%% SaleToPOIDeviceResponseV04 recursion level 0 with max 0
SaleToPOIDeviceResponseV04 *-- "1..1" Header41 : Header
SaleToPOIDeviceResponseV04 *-- "1..1" DeviceResponse5 : DeviceResponse
SaleToPOIDeviceResponseV04 *-- "0..1" ContentInformationType29 : 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

DeviceResponse building block

Information related to the response of a device request. This component define the type of Device service to be used with this message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DeviceResponse5 recursion level 0 with max 1
class DeviceResponse5{
    ServiceContent RetailerService9Code
}
DeviceResponse5 *-- "0..1" CardPaymentEnvironment78 : Environment
DeviceResponse5 *-- "0..1" CardPaymentContext29 : Context
DeviceResponse5 *-- "0..1" DeviceDisplayResponse2 : DisplayResponse
DeviceResponse5 *-- "0..1" DeviceInputResponse4 : InputResponse
DeviceResponse5 *-- "0..1" DevicePrintResponse1 : PrintResponse
DeviceResponse5 *-- "0..1" DeviceSecureInputResponse4 : SecureInputResponse
DeviceResponse5 *-- "0..1" DeviceInitialisationCardReaderResponse2 : InitialisationCardReaderResponse
DeviceResponse5 *-- "0..1" DeviceSendApplicationProtocolDataUnitCardReaderResponse1 : CardReaderApplicationProtocolDataUnitResponse
DeviceResponse5 *-- "0..1" DeviceTransmitMessageResponse1 : TransmissionResponse
DeviceResponse5 *-- "1..1" ResponseType11 : Response
DeviceResponse5 *-- "0..0" SupplementaryData1 : SupplementaryData
%% CardPaymentEnvironment78 recursion level 1 with max 1
CardPaymentEnvironment78 *-- "0..1" Acquirer10 : Acquirer
CardPaymentEnvironment78 *-- "0..1" Organisation41 : Merchant
CardPaymentEnvironment78 *-- "0..1" PointOfInteraction12 : POI
CardPaymentEnvironment78 *-- "0..1" PaymentCard32 : Card
CardPaymentEnvironment78 *-- "0..1" Check1 : Check
CardPaymentEnvironment78 *-- "0..0" StoredValueAccount2 : StoredValueAccount
CardPaymentEnvironment78 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardPaymentEnvironment78 *-- "0..1" CustomerDevice3 : CustomerDevice
CardPaymentEnvironment78 *-- "0..1" CustomerDevice3 : Wallet
CardPaymentEnvironment78 *-- "0..1" Token1 : PaymentToken
CardPaymentEnvironment78 *-- "0..1" MerchantToken2 : MerchantToken
CardPaymentEnvironment78 *-- "0..1" Cardholder18 : Cardholder
CardPaymentEnvironment78 *-- "0..1" ContentInformationType32 : ProtectedCardholderData
CardPaymentEnvironment78 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment
%% CardPaymentContext29 recursion level 1 with max 1
CardPaymentContext29 *-- "0..1" PaymentContext28 : PaymentContext
CardPaymentContext29 *-- "0..1" SaleContext4 : SaleContext
CardPaymentContext29 *-- "0..1" CardDirectDebit2 : DirectDebitContext
%% DeviceDisplayResponse2 recursion level 1 with max 1
DeviceDisplayResponse2 *-- "1..0" OutputResult2 : OutputResult
%% DeviceInputResponse4 recursion level 1 with max 1
DeviceInputResponse4 *-- "0..1" OutputResult2 : OutputResult
DeviceInputResponse4 *-- "1..1" InputResult4 : InputResult
%% DevicePrintResponse1 recursion level 1 with max 1
class DevicePrintResponse1{
    DocumentQualifier DocumentType7Code
}
%% DeviceSecureInputResponse4 recursion level 1 with max 1
DeviceSecureInputResponse4 *-- "0..1" OnLinePIN9 : CardholderPIN
%% DeviceInitialisationCardReaderResponse2 recursion level 1 with max 1
class DeviceInitialisationCardReaderResponse2{
    CardEntryMode CardDataReading8Code
    AdditionalInformation IsoMax10000Binary
}
DeviceInitialisationCardReaderResponse2 *-- "0..1" ICCResetData1 : ICCResetData
%% DeviceSendApplicationProtocolDataUnitCardReaderResponse1 recursion level 1 with max 1
class DeviceSendApplicationProtocolDataUnitCardReaderResponse1{
    Data IsoMin1Max256Binary
    CardStatus IsoMin1Max256Binary
}
%% DeviceTransmitMessageResponse1 recursion level 1 with max 1
class DeviceTransmitMessageResponse1{
    ReceivedMessage IsoMax100KBinary
}
%% ResponseType11 recursion level 1 with max 1
class ResponseType11{
    Response Response11Code
    ResponseReason RetailerResultDetail1Code
    AdditionalResponseInformation IsoMax140Text
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

DeviceResponse5 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
%% ContentInformationType29 recursion level 0 with max 1
class ContentInformationType29{
    ContentType ContentType2Code
}
ContentInformationType29 *-- "0..1" AuthenticatedData8 : AuthenticatedData
ContentInformationType29 *-- "0..1" SignedData7 : SignedData
%% AuthenticatedData8 recursion level 1 with max 1
class AuthenticatedData8{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData8 *-- "1..0" IRecipient11Choice : Recipient
AuthenticatedData8 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData8 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData7 recursion level 1 with max 1
class SignedData7{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData7 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData7 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData7 *-- "0..0" Signer6 : Signer
  

ContentInformationType29 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SaleToPOIDeviceResponseV04 --|> IOuterRecord : Implements
    SaleToPOIDeviceResponseV04Document --|> IOuterDocument~SaleToPOIDeviceResponseV04~ : Implements
    class IOuterDocument~SaleToPOIDeviceResponseV04~ {
        SaleToPOIDeviceResponseV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SaleToPOIDeviceResponseV04Document *-- SaleToPOIDeviceResponseV04 : 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.017.001.04">
    <SaleToPOIDvcRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <DvcRspn>
            <!-- DeviceResponse inner content -->
        </DvcRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </SaleToPOIDvcRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_8NC34U6qEeyGi9JAv6wq7Q"
  nextVersions="_FZbgYXPOEe2pK6udhxEaHA"
  previousVersion="_ldR7AS5KEeunNvJlR_vCbg"
  name="SaleToPOIDeviceResponseV04"
  definition="The SaleToPOIDeviceResponse message is sent by a POI System to sale system to provide result of a device request."
  registrationStatus="Registered"
  messageSet="_IwdwsFSSEeqZkqCw0Z-zEQ"
  xmlTag="SaleToPOIDvcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_8NC3406qEeyGi9JAv6wq7Q"
    nextVersions="_FZbgY3POEe2pK6udhxEaHA"
    previousVersion="_ldR7Ay5KEeunNvJlR_vCbg"
    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="_8NC35U6qEeyGi9JAv6wq7Q"
    nextVersions="_FZbgZXPOEe2pK6udhxEaHA"
    previousVersion="_ldR7BS5KEeunNvJlR_vCbg"
    name="DeviceResponse"
    definition="Information related to the response of a device request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DvcRspn"
    complexType="_mcri4U6qEeyGi9JAv6wq7Q" />
  <messageBuildingBlock
    xmi:id="_8NC3506qEeyGi9JAv6wq7Q"
    nextVersions="_FZbgZ3POEe2pK6udhxEaHA"
    previousVersion="_ldR7By5KEeunNvJlR_vCbg"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_uXF14VE1EeyApZmLzm74zA" />
  <messageDefinitionIdentifier
    businessArea="casp"
    messageFunctionality="017"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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