casp.007.001.02
The SaleToPOIAdministrativeRequest message is sent by a sale system to POI System to request for an Administrative 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
%% SaleToPOIAdministrativeRequestV02 recursion level 0 with max 0
SaleToPOIAdministrativeRequestV02 *-- "1..1" Header41 : Header
SaleToPOIAdministrativeRequestV02 *-- "1..1" AdministrativeRequest3 : AdministrativeRequest
SaleToPOIAdministrativeRequestV02 *-- "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 |
AdministrativeRequest building block
Information related to the administrative request. This component define the type of admin service to be used with this message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AdministrativeRequest3 recursion level 0 with max 1
class AdministrativeRequest3{
AdministrativeServiceIdentification IsoMax20000Text
}
AdministrativeRequest3 *-- "1..1" CardPaymentEnvironment75 : Environment
AdministrativeRequest3 *-- "1..1" CardPaymentContext28 : Context
AdministrativeRequest3 *-- "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
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
AdministrativeRequest3 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 |
| AdministrativeServiceIdentification | Identification of the administrative service to process. | IsoMax20000Text - Optional 0..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 SaleToPOIAdministrativeRequestV02 implementation follows a specific implementaiton pattern. First of all, SaleToPOIAdministrativeRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SaleToPOIAdministrativeRequestV02Document implements IOuterDocument. Because SaleToPOIAdministrativeRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SaleToPOIAdministrativeRequestV02.
classDiagram
class IOuterRecord
SaleToPOIAdministrativeRequestV02 --|> IOuterRecord : Implements
SaleToPOIAdministrativeRequestV02Document --|> IOuterDocument~SaleToPOIAdministrativeRequestV02~ : Implements
class IOuterDocument~SaleToPOIAdministrativeRequestV02~ {
SaleToPOIAdministrativeRequestV02 Message
}
Document wrapper for serialization
The only real purpose SaleToPOIAdministrativeRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:casp.007.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SaleToPOIAdministrativeRequestV02.ToDocument() method. The returned SaleToPOIAdministrativeRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
SaleToPOIAdministrativeRequestV02Document *-- SaleToPOIAdministrativeRequestV02 : 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.007.001.02">
<SaleToPOIAdmstvReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<AdmstvReq>
<!-- AdministrativeRequest inner content -->
</AdmstvReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</SaleToPOIAdmstvReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_kjvmoQ1SEeqjM-rxn3HuXQ"
nextVersions="_IX5gQS5KEeunNvJlR_vCbg"
previousVersion="_zWwx4YYBEemxIqbaFEE8-w"
name="SaleToPOIAdministrativeRequestV02"
definition="The SaleToPOIAdministrativeRequest message is sent by a sale system to POI System to request for an Administrative service."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="SaleToPOIAdmstvReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_kjvmow1SEeqjM-rxn3HuXQ"
nextVersions="_IX5gQy5KEeunNvJlR_vCbg"
previousVersion="_zWwx44YBEemxIqbaFEE8-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="_kjvmpQ1SEeqjM-rxn3HuXQ"
nextVersions="_IX5gRS5KEeunNvJlR_vCbg"
previousVersion="_zWwx5YYBEemxIqbaFEE8-w"
name="AdministrativeRequest"
definition="Information related to the administrative request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AdmstvReq"
complexType="_aqKmMQxREeqEbo60f0v6aw" />
<messageBuildingBlock
xmi:id="_kjvmpw1SEeqjM-rxn3HuXQ"
nextVersions="_IX5gRy5KEeunNvJlR_vCbg"
previousVersion="_zWwx54YBEemxIqbaFEE8-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="007"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.