casp.002.001.01
This financial service is a response of the POI system to the Sale System after a service 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
%% SaleToPOIServiceResponseV01 recursion level 0 with max 0
SaleToPOIServiceResponseV01 *-- "1..1" Header37 : Header
SaleToPOIServiceResponseV01 *-- "1..1" ServiceResponse2 : ServiceResponse
SaleToPOIServiceResponseV01 *-- "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 response. 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
| 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. | GenericIdentification171 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification171 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability6 - 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
%% ServiceResponse2 recursion level 0 with max 1
class ServiceResponse2{
ServiceContent RetailerService3Code
}
ServiceResponse2 *-- "1..1" CardPaymentEnvironment73 : Environment
ServiceResponse2 *-- "1..1" CardPaymentContext27 : Context
ServiceResponse2 *-- "0..1" PaymentResponse1 : PaymentResponse
ServiceResponse2 *-- "0..1" ReversalResponse1 : ReversalResponse
ServiceResponse2 *-- "0..1" BalanceInquiryResponse1 : BalanceInquiryResponse
ServiceResponse2 *-- "0..1" LoyaltyResponse1 : LoyaltyResponse
ServiceResponse2 *-- "0..1" StoredValueResponse2 : StoredValueResponse
ServiceResponse2 *-- "0..1" BatchResponse1 : BatchResponse
ServiceResponse2 *-- "0..1" CardAcquisitionResponse1 : CardAcquisitionResponse
ServiceResponse2 *-- "1..1" ResponseType9 : Response
ServiceResponse2 *-- "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
%% PaymentResponse1 recursion level 1 with max 1
class PaymentResponse1{
SaleReferenceIdentification IsoMax35Text
POIReconciliationIdentification IsoMax35Text
IssuerReferenceData IsoMax35Text
}
PaymentResponse1 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
PaymentResponse1 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
PaymentResponse1 *-- "1..1" RetailerPaymentResult1 : RetailerPaymentResult
PaymentResponse1 *-- "0..0" PaymentReceipt1 : PaymentReceipt
PaymentResponse1 *-- "0..0" LoyaltyResult1 : LoyaltyResult
PaymentResponse1 *-- "0..0" CustomerOrder1 : CustomerOrder
%% ReversalResponse1 recursion level 1 with max 1
class ReversalResponse1{
SaleReferenceIdentification IsoMax35Text
POIReconciliationIdentification IsoMax35Text
IssuerReferenceData IsoMax35Text
ReversedAmount IsoImpliedCurrencyAndAmount
}
ReversalResponse1 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
ReversalResponse1 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
ReversalResponse1 *-- "1..1" RetailerReversalResult1 : ReversalTransactionResult
ReversalResponse1 *-- "0..0" PaymentReceipt1 : Receipt
%% BalanceInquiryResponse1 recursion level 1 with max 1
BalanceInquiryResponse1 *-- "0..1" PaymentAccount2 : PaymentAccount
BalanceInquiryResponse1 *-- "0..1" LoyaltyAccount1 : LoyaltyAccount
BalanceInquiryResponse1 *-- "0..0" StoredValueAccount1 : StoredValueAccount
BalanceInquiryResponse1 *-- "0..0" PaymentReceipt1 : Receipt
%% LoyaltyResponse1 recursion level 1 with max 1
class LoyaltyResponse1{
POIReconciliationIdentification IsoMax35Text
}
LoyaltyResponse1 *-- "1..1" TransactionIdentifier1 : SaleTransactionIdentification
LoyaltyResponse1 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
LoyaltyResponse1 *-- "0..0" LoyaltyResult1 : Result
%% StoredValueResponse2 recursion level 1 with max 1
StoredValueResponse2 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
StoredValueResponse2 *-- "0..0" StoredValueData2 : Result
StoredValueResponse2 *-- "0..0" PaymentReceipt1 : Receipt
%% BatchResponse1 recursion level 1 with max 1
BatchResponse1 *-- "0..0" PerformedTransaction1 : PerformedTransaction
%% CardAcquisitionResponse1 recursion level 1 with max 1
class CardAcquisitionResponse1{
PaymentBrand IsoMax35Text
CustomerLanguage LanguageCode
}
CardAcquisitionResponse1 *-- "1..1" TransactionIdentifier1 : POITransactionIdentification
CardAcquisitionResponse1 *-- "0..0" LoyaltyAccount1 : LoyaltyAccount
CardAcquisitionResponse1 *-- "0..0" CustomerOrder1 : CustomerOrder
%% 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
ServiceResponse2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment73 - Required 1..1 |
| Context | Context in which the transaction is performed (payment and sale). | CardPaymentContext27 - Required 1..1 |
| ServiceContent | Define the type of service response. | RetailerService3Code - Required 1..1 |
| PaymentResponse | Data to respond to a Payment request. | PaymentResponse1 - Optional 0..1 |
| ReversalResponse | Response Data to a Reversal request. | ReversalResponse1 - Optional 0..1 |
| BalanceInquiryResponse | Response data to a balance inquiry service request. | BalanceInquiryResponse1 - Optional 0..1 |
| LoyaltyResponse | Response data to a loyalty service request. | LoyaltyResponse1 - Optional 0..1 |
| StoredValueResponse | Response data to a Stored Value request. | StoredValueResponse2 - Optional 0..1 |
| BatchResponse | Content of the Batch Response message. | BatchResponse1 - Optional 0..1 |
| CardAcquisitionResponse | Content of the Card Acquisition Response message. | CardAcquisitionResponse1 - Optional 0..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
%% 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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData5 - 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 SaleToPOIServiceResponseV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOIServiceResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIServiceResponseV01Document implements IOuterDocument. Because SaleToPOIServiceResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIServiceResponseV01.
classDiagram
class IOuterRecord
SaleToPOIServiceResponseV01 --|> IOuterRecord : Implements
SaleToPOIServiceResponseV01Document --|> IOuterDocument~SaleToPOIServiceResponseV01~ : Implements
class IOuterDocument~SaleToPOIServiceResponseV01~ {
SaleToPOIServiceResponseV01 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIServiceResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIServiceResponseV01.ToDocument() method. The returned SaleToPOIServiceResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIServiceResponseV01Document *-- SaleToPOIServiceResponseV01 : 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.01">
<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="_Qjrp8YYAEemxIqbaFEE8-w"
nextVersions="_umpHkQ1VEeqjM-rxn3HuXQ"
name="SaleToPOIServiceResponseV01"
definition="This financial service is a response of the POI system to the Sale System after a service request."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOISvcRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Qjrp84YAEemxIqbaFEE8-w"
nextVersions="_umpuoQ1VEeqjM-rxn3HuXQ"
name="Header"
definition="Set of characteristics related to the transfer of the response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_vgI-odj3EeiojJsa6FYyew" />
<messageBuildingBlock
xmi:id="_Qjrp9YYAEemxIqbaFEE8-w"
nextVersions="_umpuow1VEeqjM-rxn3HuXQ"
name="ServiceResponse"
definition="Information related to the response of a service request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SvcRspn"
complexType="_XH490YYAEemxIqbaFEE8-w" />
<messageBuildingBlock
xmi:id="_Qjrp94YAEemxIqbaFEE8-w"
nextVersions="_umpupQ1VEeqjM-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="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.