casp.002.001.04
The SaleToPOIServiceResponse message is sent by a POI to provide the outcome of a financial service.
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
%% SaleToPOIServiceResponseV04 recursion level 0 with max 0
SaleToPOIServiceResponseV04 *-- "1..1" Header41 : Header
SaleToPOIServiceResponseV04 *-- "1..1" ServiceResponse6 : ServiceResponse
SaleToPOIServiceResponseV04 *-- "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 response. 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 |
ServiceResponse building block
Information related to the response of a service request. This component contains the response of the corresponding service request. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ServiceResponse6 recursion level 0 with max 1
class ServiceResponse6{
ServiceContent RetailerService3Code
}
ServiceResponse6 *-- "1..1" CardPaymentEnvironment78 : Environment
ServiceResponse6 *-- "1..1" CardPaymentContext29 : Context
ServiceResponse6 *-- "0..1" PaymentResponse4 : PaymentResponse
ServiceResponse6 *-- "0..1" ReversalResponse6 : ReversalResponse
ServiceResponse6 *-- "0..1" BalanceInquiryResponse4 : BalanceInquiryResponse
ServiceResponse6 *-- "0..1" LoyaltyResponse3 : LoyaltyResponse
ServiceResponse6 *-- "0..1" StoredValueResponse5 : StoredValueResponse
ServiceResponse6 *-- "0..1" BatchResponse4 : BatchResponse
ServiceResponse6 *-- "0..1" CardAcquisitionResponse3 : CardAcquisitionResponse
ServiceResponse6 *-- "1..1" ResponseType11 : Response
ServiceResponse6 *-- "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
%% PaymentResponse4 recursion level 1 with max 1
class PaymentResponse4{
SaleReferenceIdentification IsoMax35Text
POIReconciliationIdentification IsoMax35Text
IssuerReferenceData IsoMax140Text
}
PaymentResponse4 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
PaymentResponse4 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
PaymentResponse4 *-- "1..1" RetailerPaymentResult4 : RetailerPaymentResult
PaymentResponse4 *-- "0..0" PaymentReceipt4 : PaymentReceipt
PaymentResponse4 *-- "0..0" LoyaltyResult3 : LoyaltyResult
PaymentResponse4 *-- "0..0" CustomerOrder1 : CustomerOrder
%% ReversalResponse6 recursion level 1 with max 1
class ReversalResponse6{
SaleReferenceIdentification IsoMax35Text
POIReconciliationIdentification IsoMax35Text
IssuerReferenceData IsoMax140Text
ReversedAmount IsoImpliedCurrencyAndAmount
}
ReversalResponse6 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
ReversalResponse6 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
ReversalResponse6 *-- "1..1" RetailerReversalResult4 : ReversalTransactionResult
ReversalResponse6 *-- "0..0" PaymentReceipt4 : Receipt
%% BalanceInquiryResponse4 recursion level 1 with max 1
BalanceInquiryResponse4 *-- "0..1" TransactionIdentifier1 : SaleTransactionIdentification
BalanceInquiryResponse4 *-- "0..1" TransactionIdentifier1 : POITransactionIdentification
BalanceInquiryResponse4 *-- "0..1" PaymentAccount3 : PaymentAccount
BalanceInquiryResponse4 *-- "0..1" LoyaltyAccount3 : LoyaltyAccount
BalanceInquiryResponse4 *-- "0..0" StoredValueAccount2 : StoredValueAccount
BalanceInquiryResponse4 *-- "0..0" PaymentReceipt4 : Receipt
%% LoyaltyResponse3 recursion level 1 with max 1
class LoyaltyResponse3{
POIReconciliationIdentification IsoMax35Text
}
LoyaltyResponse3 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
LoyaltyResponse3 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
LoyaltyResponse3 *-- "0..0" LoyaltyResult3 : Result
%% StoredValueResponse5 recursion level 1 with max 1
StoredValueResponse5 *-- "0..1" TransactionIdentifier1 : SaleTransactionIdentification
StoredValueResponse5 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
StoredValueResponse5 *-- "0..0" StoredValueData5 : Result
StoredValueResponse5 *-- "0..0" PaymentReceipt4 : Receipt
%% BatchResponse4 recursion level 1 with max 1
BatchResponse4 *-- "0..1" TransactionIdentifier1 : SaleBatchIdentification
BatchResponse4 *-- "0..1" TransactionIdentifier1 : POIBatchIdentification
BatchResponse4 *-- "0..0" PerformedTransaction4 : PerformedTransaction
%% CardAcquisitionResponse3 recursion level 1 with max 1
class CardAcquisitionResponse3{
PaymentBrand IsoMax35Text
CustomerLanguage LanguageCode
}
CardAcquisitionResponse3 *-- "0..1" TransactionIdentifier1 : SaleTransactionIdentification
CardAcquisitionResponse3 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
CardAcquisitionResponse3 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount
CardAcquisitionResponse3 *-- "0..0" CustomerOrder1 : CustomerOrder
%% 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
ServiceResponse6 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 |
| ServiceContent | Define the type of service response. | RetailerService3Code - Required 1..1 |
| PaymentResponse | Data to respond to a Payment request. | PaymentResponse4 - Optional 0..1 |
| ReversalResponse | Response Data to a Reversal request. | ReversalResponse6 - Optional 0..1 |
| BalanceInquiryResponse | Response data to a balance inquiry service request. | BalanceInquiryResponse4 - Optional 0..1 |
| LoyaltyResponse | Response data to a loyalty service request. | LoyaltyResponse3 - Optional 0..1 |
| StoredValueResponse | Response data to a Stored Value request. | StoredValueResponse5 - Optional 0..1 |
| BatchResponse | Content of the Batch Response message. | BatchResponse4 - Optional 0..1 |
| CardAcquisitionResponse | Content of the Card Acquisition Response message. | CardAcquisitionResponse3 - Optional 0..1 |
| Response | Result of the processing of the request. | ResponseType11 - 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 SaleToPOIServiceResponseV04 implementation follows a specific implementaiton pattern. First of all, SaleToPOIServiceResponseV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIServiceResponseV04Document implements IOuterDocument. Because SaleToPOIServiceResponseV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIServiceResponseV04.
classDiagram
class IOuterRecord
SaleToPOIServiceResponseV04 --|> IOuterRecord : Implements
SaleToPOIServiceResponseV04Document --|> IOuterDocument~SaleToPOIServiceResponseV04~ : Implements
class IOuterDocument~SaleToPOIServiceResponseV04~ {
SaleToPOIServiceResponseV04 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIServiceResponseV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.002.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIServiceResponseV04.ToDocument() method. The returned SaleToPOIServiceResponseV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIServiceResponseV04Document *-- SaleToPOIServiceResponseV04 : 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.002.001.04">
<SaleToPOISvcRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<SvcRspn>
<!-- ServiceResponse inner content -->
</SvcRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOISvcRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_RvI2wU0_Eeybj420QgWBkA"
nextVersions="_Hpr9IHNdEe2stM_kHP4m6A"
previousVersion="_7itroS5LEeunNvJlR_vCbg"
name="SaleToPOIServiceResponseV04"
definition="The SaleToPOIServiceResponse message is sent by a POI to provide the outcome of a financial service."
registrationStatus="Registered"
messageSet="_IwdwsFSSEeqZkqCw0Z-zEQ"
xmlTag="SaleToPOISvcRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_RvI2w00_Eeybj420QgWBkA"
nextVersions="_Hpr9InNdEe2stM_kHP4m6A"
previousVersion="_7itroy5LEeunNvJlR_vCbg"
name="Header"
definition="Set of characteristics related to the transfer of the response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_BwWUYQuKEeqYM5yH99IYQw" />
<messageBuildingBlock
xmi:id="_RvI2xU0_Eeybj420QgWBkA"
nextVersions="_HptLQXNdEe2stM_kHP4m6A"
previousVersion="_7itrpS5LEeunNvJlR_vCbg"
name="ServiceResponse"
definition="Information related to the response of a service request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SvcRspn"
complexType="_BynvsU0_Eeybj420QgWBkA" />
<messageBuildingBlock
xmi:id="_RvI2x00_Eeybj420QgWBkA"
nextVersions="_HpuZYXNdEe2stM_kHP4m6A"
previousVersion="_7itrpy5LEeunNvJlR_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="002"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.