CardManagementResponseV01

cain.024.001.01

The CardManagementResponse message is sent by an issuer or an agent to an acquirer in response to a CardManagementInitiation 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
%% CardManagementResponseV01 recursion level 0 with max 0
CardManagementResponseV01 *-- "1..1" Header39 : Header
CardManagementResponseV01 *-- "1..1" CardManagementResponse1 : Body
CardManagementResponseV01 *-- "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
%% Header39 recursion level 0 with max 1
class Header39{
    MessageFunction MessageFunction17Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header39 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header39 *-- "1..1" GenericIdentification172 : InitiatingParty
Header39 *-- "0..1" GenericIdentification172 : RecipientParty
Header39 *-- "0..0" AdditionalData1 : TraceData
Header39 *-- "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
  

Header39 members

Body building block

Information related to the card management response. Information related to the card management response message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CardManagementResponse1 recursion level 0 with max 1
class CardManagementResponse1{
    ICCRelatedData IsoMax10KHexBinaryText
}
CardManagementResponse1 *-- "1..1" Environment7 : Environment
CardManagementResponse1 *-- "1..1" Context5 : Context
CardManagementResponse1 *-- "1..1" Transaction81 : Transaction
CardManagementResponse1 *-- "1..1" ProcessingResult1 : ProcessingResult
CardManagementResponse1 *-- "0..0" ProtectedData1 : ProtectedData
CardManagementResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment7 recursion level 1 with max 1
Environment7 *-- "1..1" PartyIdentification197 : Acquirer
Environment7 *-- "0..1" PartyIdentification197 : Sender
Environment7 *-- "0..1" PartyIdentification197 : Receiver
Environment7 *-- "0..1" PartyIdentification204 : Acceptor
Environment7 *-- "0..1" Terminal2 : Terminal
Environment7 *-- "1..1" CardData4 : Card
Environment7 *-- "0..1" CustomerDevice2 : CustomerDevice
Environment7 *-- "0..1" Wallet1 : Wallet
Environment7 *-- "0..1" Token1 : Token
%% Context5 recursion level 1 with max 1
Context5 *-- "1..1" PointOfServiceContext1 : PointOfServiceContext
Context5 *-- "1..1" TransactionContext1 : TransactionContext
Context5 *-- "0..0" Verification1 : Verification
Context5 *-- "0..1" RiskContext1 : RiskContext
%% Transaction81 recursion level 1 with max 1
class Transaction81{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
}
Transaction81 *-- "1..1" TransactionIdentification8 : TransactionIdentification
Transaction81 *-- "0..1" Amount4 : ReconciliationAmount
Transaction81 *-- "0..0" AdditionalAmounts2 : AdditionalAmounts
Transaction81 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction81 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult1 recursion level 1 with max 1
class ProcessingResult1{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult1 *-- "0..1" ApprovalData1 : ApprovalData
ProcessingResult1 *-- "0..1" ResultData1 : ResultData
ProcessingResult1 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult1 *-- "0..0" Action9 : Action
ProcessingResult1 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult1 *-- "0..0" AdditionalInformation20 : 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
  

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

classDiagram
    class IOuterRecord
    CardManagementResponseV01 --|> IOuterRecord : Implements
    CardManagementResponseV01Document --|> IOuterDocument~CardManagementResponseV01~ : Implements
    class IOuterDocument~CardManagementResponseV01~ {
        CardManagementResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CardManagementResponseV01Document *-- CardManagementResponseV01 : 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:cain.024.001.01">
    <CardMgmtRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </CardMgmtRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_sGL-NVgTEeedJb6VxsnkPg"
  nextVersions="_0fzzwYN1EeuHqfO1LgkE9Q"
  name="CardManagementResponseV01"
  definition="The CardManagementResponse message is sent by an issuer or an agent to an acquirer in response to a CardManagementInitiation message."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="CardMgmtRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_sGVvMVgTEeedJb6VxsnkPg"
    nextVersions="_0fzzw4N1EeuHqfO1LgkE9Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_4s6-AVA4EeedyPuM0kK2EQ" />
  <messageBuildingBlock
    xmi:id="_sGVvMFgTEeedJb6VxsnkPg"
    nextVersions="_0fzzxYN1EeuHqfO1LgkE9Q"
    name="Body"
    definition="Information related to the card management response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_TwkBsVgUEeedJb6VxsnkPg" />
  <messageBuildingBlock
    xmi:id="_sGVvMlgTEeedJb6VxsnkPg"
    nextVersions="_0fzzx4N1EeuHqfO1LgkE9Q"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="cain"
    messageFunctionality="024"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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