casp.012.001.04
The SaleToPOIEventNotification message is sent by a POI or a sale terminal to inform the other about the happening of an event.
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
%% SaleToPOIEventNotificationV04 recursion level 0 with max 0
SaleToPOIEventNotificationV04 *-- "1..1" Header41 : Header
SaleToPOIEventNotificationV04 *-- "1..1" SystemEventNotification5 : EventNotification
SaleToPOIEventNotificationV04 *-- "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
| 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 |
EventNotification building block
Information related to the notification of an event. This component define the type of system service to be used with this message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SystemEventNotification5 recursion level 0 with max 1
SystemEventNotification5 *-- "1..1" CardPaymentEnvironment78 : Environment
SystemEventNotification5 *-- "1..1" CardPaymentContext29 : Context
SystemEventNotification5 *-- "1..1" EventNotificationData4 : EventNotification
SystemEventNotification5 *-- "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
%% EventNotificationData4 recursion level 1 with max 1
class EventNotificationData4{
MaintenanceRequiredFlag IsoTrueFalseIndicator
CustomerLanguage LanguageCode
}
EventNotificationData4 *-- "1..1" RetailerEvent4 : RetailerEvent
EventNotificationData4 *-- "0..1" ActionMessage9 : DisplayOutput
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
SystemEventNotification5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment78 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext29 - Required 1..1 |
| EventNotification | Content of the EventNotification message. | EventNotificationData4 - Required 1..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
%% 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData8 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData7 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the SaleToPOIEventNotificationV04 implementation follows a specific implementaiton pattern. First of all, SaleToPOIEventNotificationV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIEventNotificationV04Document implements IOuterDocument. Because SaleToPOIEventNotificationV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIEventNotificationV04.
classDiagram
class IOuterRecord
SaleToPOIEventNotificationV04 --|> IOuterRecord : Implements
SaleToPOIEventNotificationV04Document --|> IOuterDocument~SaleToPOIEventNotificationV04~ : Implements
class IOuterDocument~SaleToPOIEventNotificationV04~ {
SaleToPOIEventNotificationV04 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIEventNotificationV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.012.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIEventNotificationV04.ToDocument() method. The returned SaleToPOIEventNotificationV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIEventNotificationV04Document *-- SaleToPOIEventNotificationV04 : 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.012.001.04">
<SaleToPOIEvtNtfctn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<EvtNtfctn>
<!-- EventNotification inner content -->
</EvtNtfctn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIEvtNtfctn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5LB2YU7AEeyGi9JAv6wq7Q"
nextVersions="_9QDNMXPHEe2pK6udhxEaHA"
previousVersion="_Zhjd8S5MEeunNvJlR_vCbg"
name="SaleToPOIEventNotificationV04"
definition="The SaleToPOIEventNotification message is sent by a POI or a sale terminal to inform the other about the happening of an event."
registrationStatus="Registered"
messageSet="_IwdwsFSSEeqZkqCw0Z-zEQ"
xmlTag="SaleToPOIEvtNtfctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_5LB2Y07AEeyGi9JAv6wq7Q"
nextVersions="_9QDNM3PHEe2pK6udhxEaHA"
previousVersion="_Zhjd8y5MEeunNvJlR_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="_5LB2ZU7AEeyGi9JAv6wq7Q"
nextVersions="_9QDNNXPHEe2pK6udhxEaHA"
previousVersion="_Zhjd9S5MEeunNvJlR_vCbg"
name="EventNotification"
definition="Information related to the notification of an event."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="EvtNtfctn"
complexType="_vx7ZAU7AEeyGi9JAv6wq7Q" />
<messageBuildingBlock
xmi:id="_5LB2Z07AEeyGi9JAv6wq7Q"
nextVersions="_9QDNN3PHEe2pK6udhxEaHA"
previousVersion="_Zhjd9y5MEeunNvJlR_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="012"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.