KeyExchangeResponseV02

canm.004.001.02

The KeyExchangeResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a KeyExchangeInitiation message.

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
%% KeyExchangeResponseV02 recursion level 0 with max 0
KeyExchangeResponseV02 *-- "1..1" Header44 : Header
KeyExchangeResponseV02 *-- "1..1" KeyExchangeResponse1 : Body
KeyExchangeResponseV02 *-- "0..1" ContentInformationType20 : SecurityTrailer
  

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

Header building block

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

classDiagram
   direction tb
%% Header44 recursion level 0 with max 1
class Header44{
    MessageFunction MessageFunction25Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    RetransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header44 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header44 *-- "1..1" GenericIdentification172 : InitiatingParty
Header44 *-- "0..1" GenericIdentification172 : RecipientParty
Header44 *-- "0..0" AdditionalData1 : TraceData
Header44 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
  

Header44 members

Body building block

Contains information pertaining to a key exchange. Information related to a key exchange activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% KeyExchangeResponse1 recursion level 0 with max 1
KeyExchangeResponse1 *-- "0..1" Context8 : Context
KeyExchangeResponse1 *-- "1..1" Transaction100 : Transaction
KeyExchangeResponse1 *-- "1..1" ProcessingResult4 : ProcessingResult
KeyExchangeResponse1 *-- "0..0" ProtectedData1 : ProtectedData
KeyExchangeResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Context8 recursion level 1 with max 1
Context8 *-- "0..1" TransactionContext5 : TransactionContext
%% Transaction100 recursion level 1 with max 1
class Transaction100{
    KeyExchangeFunction CardServiceType5Code
    OtherKeyExchangeFunction IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    KeyExchangeType KeyType1Code
    OtherKeyExchangeType IsoMax35Text
}
Transaction100 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction100 *-- "0..1" KeyExchangeData1 : KeyExchangeData
Transaction100 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction100 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult4 recursion level 1 with max 1
ProcessingResult4 *-- "0..1" ResultData5 : ResultData
ProcessingResult4 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult4 *-- "0..0" AdditionalInformation22 : AdditionalInformation
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
    ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

KeyExchangeResponse1 members

SecurityTrailer building block

Trailer of the message containing a MAC General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
    MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
    Control IsoExact1HexBinaryText
    KeySetIdentifier IsoMax8NumericText
    DerivedInformation IsoMax32HexBinaryText
    Algorithm IsoMax2NumericText
    KeyLength IsoMax4NumericText
    KeyProtection IsoMax2NumericText
    KeyIndex IsoMax5NumericText
    PaddingMethod IsoMax2NumericText
    InitialisationVector IsoMax32HexBinaryText
}
  

ContentInformationType20 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    KeyExchangeResponseV02 --|> IOuterRecord : Implements
    KeyExchangeResponseV02Document --|> IOuterDocument~KeyExchangeResponseV02~ : Implements
    class IOuterDocument~KeyExchangeResponseV02~ {
        KeyExchangeResponseV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    KeyExchangeResponseV02Document *-- KeyExchangeResponseV02 : 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:canm.004.001.02">
    <KeyXchgRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </KeyXchgRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_mpuu1lWdEeeiG_nL4vgKnQ"
  nextVersions="_X7oCEYv7EeumSPwlS1PkxQ"
  previousVersion="_UPyNIHvQEeS2PZh7wUMQog"
  name="KeyExchangeResponseV02"
  definition="The KeyExchangeResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a KeyExchangeInitiation message.&#xD;&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="KeyXchgRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_mpuu11WdEeeiG_nL4vgKnQ"
    nextVersions="_X7oCE4v7EeumSPwlS1PkxQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_q9fuQVWWEeeiG_nL4vgKnQ" />
  <messageBuildingBlock
    xmi:id="_mpuu2VWdEeeiG_nL4vgKnQ"
    nextVersions="_X7oCFYv7EeumSPwlS1PkxQ"
    name="Body"
    definition="Contains information pertaining to a key exchange. "
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_dnN6lVWfEeeiG_nL4vgKnQ" />
  <messageBuildingBlock
    xmi:id="_mpuu2lWdEeeiG_nL4vgKnQ"
    nextVersions="_X7oCF4v7EeumSPwlS1PkxQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="canm"
    messageFunctionality="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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