CertificateManagementResponseV01

catm.008.001.01

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
%% CertificateManagementResponseV01 recursion level 0 with max 0
CertificateManagementResponseV01 *-- "1..1" Header29 : Header
CertificateManagementResponseV01 *-- "1..1" CertificateManagementResponse1 : CertificateManagementResponse
CertificateManagementResponseV01 *-- "0..1" ContentInformationType13 : 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 reject of a transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header29 recursion level 0 with max 1
class Header29{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header29 *-- "1..1" GenericIdentification72 : InitiatingParty
Header29 *-- "0..1" GenericIdentification93 : RecipientParty
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification93 recursion level 1 with max 1
class GenericIdentification93{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification93 *-- "0..1" NetworkParameters5 : RemoteAccess
  

Header29 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
%% CertificateManagementResponse1 recursion level 0 with max 1
class CertificateManagementResponse1{
    CertificateService CardPaymentServiceType10Code
    SecurityProfile IsoMax35Text
    ClientCertificate IsoMax3000Binary
    ClientCertificatePath IsoMax10KBinary
    ServerCertificatePath IsoMax10KBinary
}
CertificateManagementResponse1 *-- "1..1" GenericIdentification72 : POIIdentification
CertificateManagementResponse1 *-- "0..1" GenericIdentification72 : TMIdentification
CertificateManagementResponse1 *-- "1..1" ResponseType6 : Result
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% ResponseType6 recursion level 1 with max 1
class ResponseType6{
    Response Response2Code
    ResponseDetail ResultDetail3Code
    AdditionalResponse IsoMax140Text
}
  

CertificateManagementResponse1 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
%% ContentInformationType13 recursion level 0 with max 1
class ContentInformationType13{
    ContentType ContentType2Code
}
ContentInformationType13 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType13 *-- "0..1" SignedData4 : SignedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData4 recursion level 1 with max 1
class SignedData4{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData4 *-- "1..0" AlgorithmIdentification16 : DigestAlgorithm
SignedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
SignedData4 *-- "1..0" Signer3 : Signer
  

ContentInformationType13 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CertificateManagementResponseV01 --|> IOuterRecord : Implements
    CertificateManagementResponseV01Document --|> IOuterDocument~CertificateManagementResponseV01~ : Implements
    class IOuterDocument~CertificateManagementResponseV01~ {
        CertificateManagementResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CertificateManagementResponseV01Document *-- CertificateManagementResponseV01 : 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.01">
    <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="_3Sq4UI4VEeW6h7rGyYlyTg"
  nextVersions="_MtCPodtdEee9e6xduATmQg"
  name="CertificateManagementResponseV01"
  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="_ArNVAI4WEeW6h7rGyYlyTg"
    nextVersions="_MtCPo9tdEee9e6xduATmQg"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_RtBnUY4CEeWrZqsymMFdfg" />
  <messageBuildingBlock
    xmi:id="_dXALEI4WEeW6h7rGyYlyTg"
    nextVersions="_MtCPpdtdEee9e6xduATmQg"
    name="CertificateManagementResponse"
    definition="Information related to the result of the certificate management request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CertMgmtRspn"
    complexType="_PATyUI4WEeW6h7rGyYlyTg" />
  <messageBuildingBlock
    xmi:id="_mhfksI4WEeW6h7rGyYlyTg"
    nextVersions="_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="_R_tFoYreEeSvuOJS0mmL0g" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="008"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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