casp.004.001.02
The SaleToPOIReconciliationResponse message is sent by a POI to provide the result of reconciliation process between sale and POI systems.
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
%% SaleToPOIReconciliationResponseV02 recursion level 0 with max 0
SaleToPOIReconciliationResponseV02 *-- "1..1" Header41 : Header
SaleToPOIReconciliationResponseV02 *-- "1..1" ReconciliationResponse4 : ReconciliationResponse
SaleToPOIReconciliationResponseV02 *-- "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 |
ReconciliationResponse building block
Information related to the response of a reconciliation request. This component define the type of financial service to be used with this message of Reconciliation. This is only one service : ReconcialiationResponse. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReconciliationResponse4 recursion level 0 with max 1
ReconciliationResponse4 *-- "1..1" CardPaymentEnvironment75 : Environment
ReconciliationResponse4 *-- "1..1" CardPaymentContext28 : Context
ReconciliationResponse4 *-- "1..1" ReconciliationResponseData1 : ReconciliationResponseData
ReconciliationResponse4 *-- "1..1" ResponseType9 : Response
ReconciliationResponse4 *-- "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
%% ReconciliationResponseData1 recursion level 1 with max 1
class ReconciliationResponseData1{
ReconciliationType ReconciliationType1Code
POIReconciliationIdentification IsoMax35Text
}
ReconciliationResponseData1 *-- "0..0" TransactionTotalsSet1 : TransactionTotals
%% 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
ReconciliationResponse4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment75 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext28 - Required 1..1 |
| ReconciliationResponseData | Content of the Reconciliation Response message. | ReconciliationResponseData1 - Required 1..1 |
| Response | Result of the processing of the request. | ResponseType9 - 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
%% 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 SaleToPOIReconciliationResponseV02 implementation follows a specific implementaiton pattern. First of all, SaleToPOIReconciliationResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIReconciliationResponseV02Document implements IOuterDocument. Because SaleToPOIReconciliationResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIReconciliationResponseV02.
classDiagram
class IOuterRecord
SaleToPOIReconciliationResponseV02 --|> IOuterRecord : Implements
SaleToPOIReconciliationResponseV02Document --|> IOuterDocument~SaleToPOIReconciliationResponseV02~ : Implements
class IOuterDocument~SaleToPOIReconciliationResponseV02~ {
SaleToPOIReconciliationResponseV02 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIReconciliationResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.004.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIReconciliationResponseV02.ToDocument() method. The returned SaleToPOIReconciliationResponseV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIReconciliationResponseV02Document *-- SaleToPOIReconciliationResponseV02 : 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.004.001.02">
<SaleToPOIRcncltnRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RcncltnRspn>
<!-- ReconciliationResponse inner content -->
</RcncltnRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIRcncltnRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_2r5z8Q1UEeqjM-rxn3HuXQ"
nextVersions="_UvYk4S5LEeunNvJlR_vCbg"
previousVersion="_xacroYYAEemxIqbaFEE8-w"
name="SaleToPOIReconciliationResponseV02"
definition="The SaleToPOIReconciliationResponse message is sent by a POI to provide the result of reconciliation process between sale and POI systems."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOIRcncltnRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_2r5z8w1UEeqjM-rxn3HuXQ"
nextVersions="_UvYk4y5LEeunNvJlR_vCbg"
previousVersion="_xadSsYYAEemxIqbaFEE8-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="_2r5z9Q1UEeqjM-rxn3HuXQ"
nextVersions="_UvYk5S5LEeunNvJlR_vCbg"
previousVersion="_xadSs4YAEemxIqbaFEE8-w"
name="ReconciliationResponse"
definition="Information related to the response of a reconciliation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnRspn"
complexType="_Q8zZEQ1OEeqjM-rxn3HuXQ" />
<messageBuildingBlock
xmi:id="_2r5z9w1UEeqjM-rxn3HuXQ"
nextVersions="_UvYk5y5LEeunNvJlR_vCbg"
previousVersion="_xadStYYAEemxIqbaFEE8-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="004"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.