CertificateManagementResponseV03

catm.008.001.03

The CertificateManagementResponse is sent by a terminal manager in response to a CertificateManagementRequest to provide the outcome of the requested 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
%% CertificateManagementResponseV03 recursion level 0 with max 0
CertificateManagementResponseV03 *-- "1..1" TMSHeader1 : Header
CertificateManagementResponseV03 *-- "1..1" CertificateManagementResponse2 : CertificateManagementResponse
CertificateManagementResponseV03 *-- "0..1" ContentInformationType21 : SecurityTrailer
  

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Information related to the protocol management. Set of characteristics related to the transfer of transactions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TMSHeader1 recursion level 0 with max 1
class TMSHeader1{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
TMSHeader1 *-- "1..1" GenericIdentification176 : InitiatingParty
TMSHeader1 *-- "0..1" GenericIdentification177 : RecipientParty
TMSHeader1 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% 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
  

TMSHeader1 members

CertificateManagementResponse building block

Information related to the result of the certificate management request. Information related to the result of the certificate management request. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CertificateManagementResponse2 recursion level 0 with max 1
class CertificateManagementResponse2{
    CertificateService CardPaymentServiceType10Code
    SecurityProfile IsoMax35Text
    ClientCertificate IsoMax3000Binary
    ClientCertificatePath IsoMax10KBinary
    ServerCertificatePath IsoMax10KBinary
}
CertificateManagementResponse2 *-- "1..1" GenericIdentification176 : POIIdentification
CertificateManagementResponse2 *-- "0..1" GenericIdentification176 : TMIdentification
CertificateManagementResponse2 *-- "1..1" ResponseType6 : Result
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% ResponseType6 recursion level 1 with max 1
class ResponseType6{
    Response Response2Code
    ResponseDetail ResultDetail3Code
    AdditionalResponse IsoMax140Text
}
  

CertificateManagementResponse2 members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the CertificateManagementResponseV03 implementation follows a specific implementaiton pattern. First of all, CertificateManagementResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CertificateManagementResponseV03Document implements IOuterDocument. Because CertificateManagementResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CertificateManagementResponseV03.

classDiagram
    class IOuterRecord
    CertificateManagementResponseV03 --|> IOuterRecord : Implements
    CertificateManagementResponseV03Document --|> IOuterDocument~CertificateManagementResponseV03~ : Implements
    class IOuterDocument~CertificateManagementResponseV03~ {
        CertificateManagementResponseV03 Message
     }
  

Document wrapper for serialization

The only real purpose CertificateManagementResponseV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.008.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CertificateManagementResponseV03.ToDocument() method. The returned CertificateManagementResponseV03Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    CertificateManagementResponseV03Document *-- CertificateManagementResponseV03 : 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:catm.008.001.03">
    <CertMgmtRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CertMgmtRspn>
            <!-- CertificateManagementResponse inner content -->
        </CertMgmtRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </CertMgmtRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_JWMugQ0WEeqUVL7sB4m7NA"
  nextVersions="_HbVIQS8kEeu125Ip9zFcsQ"
  previousVersion="_MtCPodtdEee9e6xduATmQg"
  name="CertificateManagementResponseV03"
  definition="The CertificateManagementResponse is sent by a terminal manager in response to a CertificateManagementRequest to provide the outcome of the requested service."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CertMgmtRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_JWNVkQ0WEeqUVL7sB4m7NA"
    nextVersions="_HbVIQy8kEeu125Ip9zFcsQ"
    previousVersion="_MtCPo9tdEee9e6xduATmQg"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_JWNVkw0WEeqUVL7sB4m7NA"
    nextVersions="_HbVIRS8kEeu125Ip9zFcsQ"
    previousVersion="_MtCPpdtdEee9e6xduATmQg"
    name="CertificateManagementResponse"
    definition="Information related to the result of the certificate management request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CertMgmtRspn"
    complexType="_mY6FMQ0VEeqUVL7sB4m7NA" />
  <messageBuildingBlock
    xmi:id="_JWNVlQ0WEeqUVL7sB4m7NA"
    nextVersions="_HbVIRy8kEeu125Ip9zFcsQ"
    previousVersion="_MtCPp9tdEee9e6xduATmQg"
    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="catm"
    messageFunctionality="008"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.