casp.014.001.01
A Message Status Request is sent by the Sale system when the sale system wants to know the status of previous message that has not be answered.
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
%% SaleToPOIMessageStatusRequestV01 recursion level 0 with max 0
SaleToPOIMessageStatusRequestV01 *-- "1..1" Header37 : Header
SaleToPOIMessageStatusRequestV01 *-- "1..1" MessageStatusRequest2 : StatusRequest
SaleToPOIMessageStatusRequestV01 *-- "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
| 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 |
StatusRequest building block
Information related to a status request. Contents information to identify a previous exchange. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageStatusRequest2 recursion level 0 with max 1
MessageStatusRequest2 *-- "1..1" CardPaymentEnvironment73 : Environment
MessageStatusRequest2 *-- "1..1" CardPaymentContext27 : Context
MessageStatusRequest2 *-- "1..1" MessageStatusRequestData1 : MessageStatusRequestData
MessageStatusRequest2 *-- "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
%% MessageStatusRequestData1 recursion level 1 with max 1
class MessageStatusRequestData1{
ExchangeIdentification IsoMax35Text
ReceiptReprintFlag IsoTrueFalseIndicator
DocumentQualifier DocumentType7Code
}
MessageStatusRequestData1 *-- "1..1" GenericIdentification171 : InitiatingParty
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
MessageStatusRequest2 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 |
| MessageStatusRequestData | Identification of the previous exchange. | MessageStatusRequestData1 - 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 SaleToPOIMessageStatusRequestV01 implementation follows a specific implementaiton pattern. First of all, SaleToPOIMessageStatusRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIMessageStatusRequestV01Document implements IOuterDocument. Because SaleToPOIMessageStatusRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIMessageStatusRequestV01.
classDiagram
class IOuterRecord
SaleToPOIMessageStatusRequestV01 --|> IOuterRecord : Implements
SaleToPOIMessageStatusRequestV01Document --|> IOuterDocument~SaleToPOIMessageStatusRequestV01~ : Implements
class IOuterDocument~SaleToPOIMessageStatusRequestV01~ {
SaleToPOIMessageStatusRequestV01 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIMessageStatusRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.014.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIMessageStatusRequestV01.ToDocument() method. The returned SaleToPOIMessageStatusRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIMessageStatusRequestV01Document *-- SaleToPOIMessageStatusRequestV01 : 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.014.001.01">
<SaleToPOIMsgStsReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<StsReq>
<!-- StatusRequest inner content -->
</StsReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIMsgStsReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_2ol5kYYCEemxIqbaFEE8-w"
nextVersions="_Qcw_YQ1UEeqjM-rxn3HuXQ"
name="SaleToPOIMessageStatusRequestV01"
definition="A Message Status Request is sent by the Sale system when the sale system wants to know the status of previous message that has not be answered."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOIMsgStsReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_2ol5k4YCEemxIqbaFEE8-w"
nextVersions="_Qcw_Yw1UEeqjM-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="_2ol5lYYCEemxIqbaFEE8-w"
nextVersions="_Qcw_ZQ1UEeqjM-rxn3HuXQ"
name="StatusRequest"
definition="Information related to a status request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="StsReq"
complexType="_5bHrkYYCEemxIqbaFEE8-w" />
<messageBuildingBlock
xmi:id="_2ol5l4YCEemxIqbaFEE8-w"
nextVersions="_Qcw_Zw1UEeqjM-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="014"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.