KeyExchangeResponseV03

canm.004.001.03

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
%% KeyExchangeResponseV03 recursion level 0 with max 0
KeyExchangeResponseV03 *-- "1..1" Header63 : Header
KeyExchangeResponseV03 *-- "1..1" KeyExchangeResponse2 : Body
KeyExchangeResponseV03 *-- "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
%% Header63 recursion level 0 with max 1
class Header63{
    MessageFunction MessageFunction23Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header63 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header63 *-- "1..1" GenericIdentification183 : InitiatingParty
Header63 *-- "0..1" GenericIdentification183 : RecipientParty
Header63 *-- "0..0" AdditionalData1 : TraceData
Header63 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification
  

Header63 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
%% KeyExchangeResponse2 recursion level 0 with max 1
KeyExchangeResponse2 *-- "0..1" Context17 : Context
KeyExchangeResponse2 *-- "1..1" Transaction133 : Transaction
KeyExchangeResponse2 *-- "1..1" ProcessingResult19 : ProcessingResult
KeyExchangeResponse2 *-- "0..0" ProtectedData1 : ProtectedData
KeyExchangeResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction133 recursion level 1 with max 1
class Transaction133{
    KeyExchangeFunction CardServiceType5Code
    OtherKeyExchangeFunction IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    KeyExchangeType KeyType1Code
    OtherKeyExchangeType IsoMax35Text
}
Transaction133 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction133 *-- "0..1" KeyExchangeData1 : KeyExchangeData
Transaction133 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction133 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult19 recursion level 1 with max 1
ProcessingResult19 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult19 *-- "1..1" ResultData10 : ResultData
ProcessingResult19 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult19 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult19 *-- "0..0" AdditionalInformation30 : 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
  

KeyExchangeResponse2 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 KeyExchangeResponseV03 implementation follows a specific implementaiton pattern. First of all, KeyExchangeResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, KeyExchangeResponseV03Document implements IOuterDocument. Because KeyExchangeResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type KeyExchangeResponseV03.

classDiagram
    class IOuterRecord
    KeyExchangeResponseV03 --|> IOuterRecord : Implements
    KeyExchangeResponseV03Document --|> IOuterDocument~KeyExchangeResponseV03~ : Implements
    class IOuterDocument~KeyExchangeResponseV03~ {
        KeyExchangeResponseV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    KeyExchangeResponseV03Document *-- KeyExchangeResponseV03 : 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.03">
    <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="_X7oCEYv7EeumSPwlS1PkxQ"
  previousVersion="_mpuu1lWdEeeiG_nL4vgKnQ"
  name="KeyExchangeResponseV03"
  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="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="KeyXchgRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_X7oCE4v7EeumSPwlS1PkxQ"
    previousVersion="_mpuu11WdEeeiG_nL4vgKnQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_pKuBkRvVEey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_X7oCFYv7EeumSPwlS1PkxQ"
    previousVersion="_mpuu2VWdEeeiG_nL4vgKnQ"
    name="Body"
    definition="Contains information pertaining to a key exchange. "
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_K7wSUYv7EeumSPwlS1PkxQ" />
  <messageBuildingBlock
    xmi:id="_X7oCF4v7EeumSPwlS1PkxQ"
    previousVersion="_mpuu2lWdEeeiG_nL4vgKnQ"
    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="03" />
</messageDefinition>

ISO Building Blocks

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