SaleToPOIDeviceResponseV01

casp.017.001.01

This message is a Response 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
%% SaleToPOIDeviceResponseV01 recursion level 0 with max 0
SaleToPOIDeviceResponseV01 *-- "1..1" Header37 : Header
SaleToPOIDeviceResponseV01 *-- "1..1" DeviceResponse2 : DeviceResponse
SaleToPOIDeviceResponseV01 *-- "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

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
%% DeviceResponse2 recursion level 0 with max 1
class DeviceResponse2{
    ServiceContent RetailerService9Code
}
DeviceResponse2 *-- "1..1" CardPaymentEnvironment73 : Environment
DeviceResponse2 *-- "1..1" CardPaymentContext27 : Context
DeviceResponse2 *-- "0..1" DeviceDisplayResponse1 : DisplayResponse
DeviceResponse2 *-- "0..1" DeviceInputResponse1 : InputResponse
DeviceResponse2 *-- "0..1" DevicePrintResponse1 : PrintResponse
DeviceResponse2 *-- "0..1" DeviceSecureInputResponse1 : SecureInputResponse
DeviceResponse2 *-- "0..1" DeviceInitialisationCardReaderResponse1 : InitialisationCardReaderResponse
DeviceResponse2 *-- "0..1" DeviceSendApplicationProtocolDataUnitCardReaderResponse1 : CardReaderApplicationProtocolDataUnitResponse
DeviceResponse2 *-- "0..1" DeviceTransmitMessageResponse1 : TransmissionResponse
DeviceResponse2 *-- "1..1" ResponseType9 : Response
DeviceResponse2 *-- "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
%% DeviceDisplayResponse1 recursion level 1 with max 1
DeviceDisplayResponse1 *-- "1..0" OutputResult1 : OutputResult
%% DeviceInputResponse1 recursion level 1 with max 1
DeviceInputResponse1 *-- "0..1" OutputResult1 : OutputResult
DeviceInputResponse1 *-- "1..1" InputResult1 : InputResult
%% DevicePrintResponse1 recursion level 1 with max 1
class DevicePrintResponse1{
    DocumentQualifier DocumentType7Code
}
%% DeviceSecureInputResponse1 recursion level 1 with max 1
DeviceSecureInputResponse1 *-- "0..1" OnLinePIN6 : CardholderPIN
%% DeviceInitialisationCardReaderResponse1 recursion level 1 with max 1
class DeviceInitialisationCardReaderResponse1{
    CardEntryMode CardDataReading6Code
    AdditionalInformation IsoMax10000Binary
}
DeviceInitialisationCardReaderResponse1 *-- "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
}
%% ResponseType9 recursion level 1 with max 1
class ResponseType9{
    Response Response5Code
    ResponseReason RetailerResultDetail1Code
    AdditionalResponseInformation IsoMax140Text
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

DeviceResponse2 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 SaleToPOIDeviceResponseV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOIDeviceResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIDeviceResponseV01Document implements IOuterDocument. Because SaleToPOIDeviceResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIDeviceResponseV01.

classDiagram
    class IOuterRecord
    SaleToPOIDeviceResponseV01 --|> IOuterRecord : Implements
    SaleToPOIDeviceResponseV01Document --|> IOuterDocument~SaleToPOIDeviceResponseV01~ : Implements
    class IOuterDocument~SaleToPOIDeviceResponseV01~ {
        SaleToPOIDeviceResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SaleToPOIDeviceResponseV01Document *-- SaleToPOIDeviceResponseV01 : 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.01">
    <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="_ZORUIYYDEemxIqbaFEE8-w"
  nextVersions="_mTaYAQ1TEeqjM-rxn3HuXQ"
  name="SaleToPOIDeviceResponseV01"
  definition="This message is a Response 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="SaleToPOIDvcRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ZORUI4YDEemxIqbaFEE8-w"
    nextVersions="_mTaYAw1TEeqjM-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="_ZORUJYYDEemxIqbaFEE8-w"
    nextVersions="_mTaYBQ1TEeqjM-rxn3HuXQ"
    name="DeviceResponse"
    definition="Information related to the response of a device request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="DvcRspn"
    complexType="_by2wwYYDEemxIqbaFEE8-w" />
  <messageBuildingBlock
    xmi:id="_ZORUJ4YDEemxIqbaFEE8-w"
    nextVersions="_mTaYBw1TEeqjM-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="017"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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