ZagTrader

canm: Network Management

canm.004 Key Exchange Response

Written and maintained by ZagTrader. Last reviewed . How this page is sourced and checked

canm.004 is the ISO 20022 KeyExchangeResponse message in the Network Management business area (canm). The latest version is canm.004.001.04, and 3 versions are in the repository.

Message
KeyExchangeResponse
Latest version
canm.004.001.04
Submitting organisation
ISO TC68/SC9/TG1
MT equivalent
None listed

In use: published in the current ISO 20022 catalogue.

What canm.004 is for

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

Definition from the ISO 20022 e-Repository, release of 24 April 2025.

canm.004 versions

Every version published in the e-Repository, newest first. A message keeps its business purpose across versions; each new version is a separate schema with its own namespace.

VersionRegistration statusPublished in
canm.004.001.04latestRegisteredLatest version set
canm.004.001.03RegisteredPrevious version set
canm.004.001.02RegisteredArchive

canm.004 message structure

The building blocks of canm.004.001.04 to three levels, with multiplicity ([0..1] optional, [1..1] mandatory, * any number) and the data type or component. Element names and definitions are from the ISO 20022 repository; usage guidelines such as CBPR+ or a market infrastructure's rules can restrict them further.

  • Document [1..1]
    • KeyXchgRspn KeyExchangeResponse [1..1]
      • Hdr Header [1..1]Header71

        Information related to the management of the protocol.

        • MsgFctn Message Function [1..1]ExternalMessageFunction1Code

          Identifies the type of process related to the message.

        • PrtcolVrsn Protocol Version [1..1]Max2048Text

          Version of the acquirer to issuer protocol specifications.

        • XchgId Exchange Identification [0..1]Max35Text

          Unique identification of an exchange of messages between two parties.

        • ReTrnsmssnCntr Re Transmission Counter [0..1]Max3NumericText

          Number of retransmission of the message.

        • CreDtTm Creation Date Time [1..1]ISODateTime

          Date and time at which the message was sent.

        • BtchMgmtInf Batch Management Information [0..1]BatchManagementInformation1

          Information related to the batch and the collection to which the message belongs if any.

          • ColltnId Collection Identification [0..1]Max35Text
          • BtchId Batch Identification [1..1]Max35Text
          • MsgSeqNb Message Sequence Number [0..1]Max15NumericText
          • MsgChcksmInptVal Message Checksum Input Value [0..1]Max140Binary
        • InitgPty Initiating Party [1..1]GenericIdentification183

          Unique identification of the partner that has initiated the exchange.

          • Id Identification [1..1]Max35Text
          • Tp Type [0..1]PartyType17Code
          • OthrTp Other Type [0..1]Max35Text
          • Assgnr Assigner [0..1]PartyType18Code
          • Ctry Country [0..1]ISOMax3ACountryCode
          • ShrtNm Short Name [0..1]Max35Text
        • RcptPty Recipient Party [0..1]GenericIdentification183

          Unique identification of the partner that is the recipient of the message exchange.

          • Id Identification [1..1]Max35Text
          • Tp Type [0..1]PartyType17Code
          • OthrTp Other Type [0..1]Max35Text
          • Assgnr Assigner [0..1]PartyType18Code
          • Ctry Country [0..1]ISOMax3ACountryCode
          • ShrtNm Short Name [0..1]Max35Text
        • TracData Trace Data [0..*]AdditionalData1

          Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange.

          • Tp Type [0..1]Max35Text
          • Val Value [0..1]Max2048Text
        • Tracblt Traceability [0..*]Traceability10

          Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges.

          • Id Identification [1..1]Max35Text
          • Tp Type [0..1]PartyType17Code
          • OthrTp Other Type [0..1]Max35Text
          • Assgnr Assigner [0..1]PartyType18Code
          • Ctry Country [0..1]ISOMax3ACountryCode
          • ShrtNm Short Name [0..1]Max35Text
          • DtTmIn Date Time In [0..1]ISODateTime
          • DtTmOut Date Time Out [0..1]ISODateTime
      • KeyXchgFctn Key Exchange Function [1..1]CardServiceType5Code

        Type of key exchange function being performed.

      • OthrKeyXchgFctn Other Key Exchange Function [0..1]Max35Text

        Other key exchange function being performed.

      • MsgRsn Message Reason [0..*]ISO8583MessageReasonCode

        Reason or purpose to send the message.

      • AltrnMsgRsn Alternate Message Reason [0..*]Max256Text

        Alternate reason to send a message.

      • Prgrmm Programme [0..1]ProgrammeMode5

        Programme, network, or brand processes the transaction.

        • ApldId Applied Identification [1..1]Max35Text

          Identification of the programme, network, or brand applied to the transaction.

        • AddtlId Additional Identification [0..*]AdditionalData1

          Additional identification of the program, network, or brand processed the transaction.

          • Tp Type [0..1]Max35Text
          • Val Value [0..1]Max2048Text
      • SysTracAudtNb System Trace Audit Number [1..1]Max12NumericText

        Number assigned by a transaction originator to assist in identifying a transaction uniquely.

      • TrnsmssnDtTm Transmission Date Time [1..1]ISODateTime

        Date and time expressed in UTC of the message as sent by the initiator.

      • RtrvlRefNb Retrieval Reference Number [0..1]Exact12Text

        A reference supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.

      • LifeCyclId Life Cycle Identification [0..1]Exact15Text

        Transaction lifecycle identification

      • KeyXchgTp Key Exchange Type [0..1]KeyType1Code

        Defines the type of key being exchanged.

      • OthrKeyXchgTp Other Key Exchange Type [0..1]Max35Text

        Other type of key being exchanged.

      • KeyXchgData Key Exchange Data [0..1]KeyExchangeData1

        Contains information pertaining to a key exchange.

        • Ctrl Control [0..1]Exact1HexBinaryText

          Identifies the key management scheme and associated structure of the remainder of the data element ISO 13492

        • KeySetIdr Key Set Identifier [0..1]Max8NumericText

          key-set identifier is a number that uniquely identifies a group of related keys that are all different but have certain characteristics in common.

        • DrvdInf Derived Information [0..1]Max32HexBinaryText

          Random number or counter in order to have a unique key per transaction.

        • Algo Algorithm [0..1]Max2NumericText

          Selects the encryption algorithm used to encipher the keys contained in the associated key management data element.

        • KeyLngth Key Length [0..1]Max4NumericText

          Specifies the length of the keys being transported, not the encrypting key.

        • KeyPrtcn Key Protection [0..1]Max2NumericText

          Mechanism used to provide key confidentiality and integrity.

        • KeyIndx Key Index [0..1]Max5NumericText

          Identifies a unique key set when multiple keys with the same key set identifier are used.

        • NcrptdData Encrypted Data [0..1]Max9999HexBinaryText

          Uses a structure within it prior to encryption to identify the data.

        • KeyChcksmVal Key Checksum Value [0..1]Max9999HexBinaryText

          Contains a value used to verify a conveyed key.

      • Jursdctn Jurisdiction [0..1]Jurisdiction2

        Contains information that identifies or is specific to a transaction jurisdiction.

        • DmstInd Domestic Indicator [0..1]TrueFalseIndicator

          When true, indicates the transaction is considered to be domestic.

        • DmstQlfctn Domestic Qualification [0..1]Max35Text

          Identifies the reason the transaction is considered to be domestic or non-domestic.

      • SttlmSvc Settlement Service [0..1]SettlementService6

        Type of settlement service for specific services requiring settlement.

        • Tp Type [0..1]Max35Text

          Type of settlement service applied

        • Id Identification [0..1]Max35Text

          Identification of settlement service applied.

        • ReqdDt Requested Date [0..1]ISODate

          Date requested for settlement.

        • Dfrrd Deferred [0..1]TrueFalseIndicator

          Indicate a deferred Settlement date.

        • Dt Date [0..1]ISODate

          Actual date of settlement.

        • Tm Time [0..1]ISOTime

          Actual time of settlement.

        • Prd Period [0..1]Max35Text

          Identifies the settlement period, cycle or group.

        • CutOffTm Cut Off Time [0..1]ISODateTime

          Identifies the effective end time of the settlement date and/or period.

        • RptgNttyTp Reporting Entity Type [0..1]Max35Text

          Identifies the type of settlement reporting entity

        • RptgNttyId Reporting Entity Identification [0..1]Max35Text

          Identification of the settlement reporting entity.

        • AddtlInf Additional Information [0..*]AdditionalData1

          Additional Settlement Information.

          • Tp Type [0..1]Max35Text
          • Val Value [0..1]Max2048Text
      • AddtlFee Additional Fee [0..*]AdditionalFee3

        Fees not included in the transaction amount.

        • Tp Type [1..1]TypeOfAmount21Code

          Type or class of fee.

        • OthrTp Other Type [0..1]Max35Text

          Additional information to specify the type of amount of fee.

        • Prgm Program [0..1]Max35Text

          Identification of fee program.

        • Dscrptr Descriptor [0..1]Max35Text

          Identification of specific fee.

        • CdtDbt Credit Debit [0..1]CreditDebit3Code

          Contains code list for a credit or debit transaction

        • Amt Amount [1..1]ImpliedCurrencyAndAmount

          Amount exclusive of currency.

        • Ccy Currency [0..1]ISO3NumericCurrencyCode

          Currency for the type of amount.

        • RcncltnAmt Reconciliation Amount [0..1]ImpliedCurrencyAndAmount

          Amount of the transaction in Reconciliation currency

        • RcncltnCcy Reconciliation Currency [0..1]ISO3NumericCurrencyCode

          Currency code of Reconciliation and associated with Reconciliation amount.

        • RcncltnFctvXchgRate Reconciliation Effective Exchange Rate [0..1]BaseOne25Rate

          Effective exchange rate used in the conversion from transaction amount to reconciliation amount.

        • Assgnr Assigner [0..1]PartyType32Code

          A code to identify the type of party who assign the fee.

        • OthrAssgnr Other Assigner [0..1]Max35Text

          Other type of party that assign the fee.

        • Desc Description [0..1]Max140Text

          Short description of the fee amount.

      • Rcncltn Reconciliation [0..1]Reconciliation4

        Identification of the reconciliation period between the acquirer and the issuer or their respective agents.

        • Id Identification [0..1]Max35Text

          Identification of the reconciliation.

        • Dt Date [0..1]ISODate

          Date of the reconciliation.

        • ChckptRef Checkpoint Reference [0..1]Max35Text

          A value used to allow a period within a reconciliation date.

      • AddtlData Additional Data [0..*]AdditionalData2

        Contains additional data.

        • Tp Type [0..1]Max35Text

          Type of information.

        • Dtls Details [0..*]AdditionalData1

          Detail of the specific type of data.

          • Tp Type [0..1]Max35Text
          • Val Value [0..1]Max2048Text
      • OrgnlRspnCd Original Response Code [0..1]ISO8583ResponseCode

        Original Response code.

      • PrcgRslt Processing Result [1..1]ProcessingResult23

        Outcome of the processing of the authorisation

        • RspnSrcId Response Source Identification [0..1]Max35Text

          Identification of response source.

        • RspnSrcTp Response Source Type [0..1]PartyType26Code

          Type of response source.

        • RspnSrcOthrTp Response Source Other Type [0..1]Max35Text

          Other type of response source.

        • RspnSrcAssgnr Response Source Assigner [0..1]PartyType9Code

          Entity that assigns the identification for the response source.

        • RspnSrcCtry Response Source Country [0..1]ISOMax3ACountryCode

          Country of the response source

        • RspnSrcShrtNm Response Source Short Name [0..1]Max35Text

          Short name of the response source

        • RspnCd Response Code [1..1]ISO8583ResponseCode

          Response code defined in ISO 8583.

        • ErrDtl Error Detail [0..*]ErrorDetails3

          Error detail information.

          • Tp Type [1..1]MessageError1Code
          • OthrTp Other Type [0..1]Max35Text
          • Cd Code [0..1]Max35Text
          • Desc Description [0..1]Max500Text
          • DataElmtInErr Data Element In Error [0..*]Max4000Text
        • AddtlInf Additional Information [0..*]AdditionalData1

          Additional information relevant for the destination.

          • Tp Type [0..1]Max35Text
          • Val Value [0..1]Max2048Text
      • PrtctdData Protected Data [0..*]ProtectedData2

        Contains protected data and the attributes used to protect the data.

        • CnttTp Content Type [1..1]ContentType3Code

          Type of data protection.

        • EnvlpdData Enveloped Data [0..1]EnvelopedData12

          Consists of an encrypted content of any type and encrypted content-encryption keys for one or more recipients.

          • Vrsn Version [0..1]Number
          • Rcpt Recipient [1..*]Recipient7Choice (choice)
          • NcrptdCntt Encrypted Content [0..1]EncryptedContent8
        • NcrptdData Encrypted Data [0..1]EncryptedData2

          Contains encrypted data and the attributes used to encrypt the data using the ISO 13492 methods for data encryption.

          • Ctrl Control [0..1]Exact1HexBinaryText
          • KeySetIdr Key Set Identifier [0..1]Max8NumericText
          • DrvdInf Derived Information [0..1]Max32HexBinaryText
          • Algo Algorithm [0..1]Max2NumericText
          • KeyLngth Key Length [0..1]Max4NumericText
          • KeyPrtcn Key Protection [0..1]Max2NumericText
          • KeyIndx Key Index [0..1]Max5NumericText
          • PddgMtd Padding Method [0..1]Max2NumericText
          • NcrptdFrmt Encrypted Format [0..1]Max2NumericText
          • NcrptdElmt Encrypted Element [1..*]EncryptedDataElement2
      • SplmtryData Supplementary Data [0..*]SupplementaryData1

        Additional information that can not be captured in the structured fields and/or other specific block.

        • PlcAndNm Place And Name [0..1]Max350Text

          Unambiguous reference to the location where the supplementary data must be inserted in the message instance.

        • Envlp Envelope [1..1]SupplementaryDataEnvelope1

          Technical element wrapping the supplementary data.

      • SctyTrlr Security Trailer [0..1]ContentInformationType41

        Trailer of the message containing a MAC.

        • MACData MAC Data [1..1]MACData1

          Type of data protection.

          • Ctrl Control [1..1]Exact1HexBinaryText
          • KeySetIdr Key Set Identifier [1..1]Max8NumericText
          • DrvdInf Derived Information [0..1]Max32HexBinaryText
          • Algo Algorithm [1..1]Max2NumericText
          • KeyLngth Key Length [0..1]Max4NumericText
          • KeyPrtcn Key Protection [0..1]Max2NumericText
          • KeyIndx Key Index [0..1]Max5NumericText
          • PddgMtd Padding Method [0..1]Max2NumericText
          • InitlstnVctr Initialisation Vector [0..1]Max32HexBinaryText
        • MAC MAC [1..1]Max8HexBinaryText

          Message Authentication Code data.

Have a canm.004 message? Paste it into the parser to see every element with its name and definition, and format checks on BICs, IBANs, dates and amounts.

External code sets used in canm.004

These elements take their values from ISO 20022 external code sets, which are published separately and updated every quarter without a new message version.

canm.004 questions

What is the latest version of canm.004?
The latest version in the ISO 20022 e-Repository release of 24 April 2025 is canm.004.001.04.
What is the root element of canm.004?
The XML document is Document with the namespace urn:iso:std:iso:20022:tech:xsd:canm.004.001.04, and its message element is KeyXchgRspn (KeyExchangeResponse).
Is there an MT equivalent of canm.004?
No Swift MT message is listed as its direct equivalent on this site. Many ISO 20022 messages have no MT counterpart.

All ISO 20022 messages · ISO 20022 code sets · MT messages

The ISO 20022 message definitions, element names and definitions on this page are reproduced from material published at iso20022.org under the ISO 20022 Intellectual Property Rights policy. This is not the official source: the up-to-date ISO 20022 standards and repository material are published only at iso20022.org. Explanations in our own words are by ZagTrader. ZagTrader is not affiliated with or endorsed by ISO or Swift.