VerificationResponseV01

cain.019.001.01

The VerificationResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a VerificationInitiation 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
%% VerificationResponseV01 recursion level 0 with max 0
VerificationResponseV01 *-- "1..1" Header39 : Header
VerificationResponseV01 *-- "1..1" VerificationResponse1 : Body
VerificationResponseV01 *-- "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 verification response Information related to the verification response message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% VerificationResponse1 recursion level 0 with max 1
class VerificationResponse1{
    ICCRelatedData IsoMax10KHexBinaryText
}
VerificationResponse1 *-- "1..1" Environment2 : Environment
VerificationResponse1 *-- "1..1" Context2 : Context
VerificationResponse1 *-- "1..1" Transaction88 : Transaction
VerificationResponse1 *-- "1..1" ProcessingResult6 : ProcessingResult
VerificationResponse1 *-- "0..0" ProtectedData1 : ProtectedData
VerificationResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment2 recursion level 1 with max 1
Environment2 *-- "1..1" PartyIdentification197 : Acquirer
Environment2 *-- "0..1" PartyIdentification197 : Sender
Environment2 *-- "0..1" PartyIdentification197 : Receiver
Environment2 *-- "0..1" PartyIdentification197 : Acceptor
Environment2 *-- "0..1" Terminal2 : Terminal
Environment2 *-- "0..1" CardData4 : Card
Environment2 *-- "0..1" Wallet1 : Wallet
Environment2 *-- "0..1" Token1 : Token
%% Context2 recursion level 1 with max 1
Context2 *-- "0..1" PointOfServiceContext1 : PointOfServiceContext
Context2 *-- "0..1" TransactionContext3 : TransactionContext
Context2 *-- "0..0" Verification2 : Verification
Context2 *-- "0..1" RiskContext1 : RiskContext
%% Transaction88 recursion level 1 with max 1
class Transaction88{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction88 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction88 *-- "1..1" TransactionIdentification11 : TransactionIdentification
Transaction88 *-- "0..1" Amount4 : ReconciliationAmount
Transaction88 *-- "0..0" AdditionalAmounts2 : AdditionalAmounts
Transaction88 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction88 *-- "0..0" AccountBalance1 : AccountBalance
Transaction88 *-- "0..1" AccountDetails2 : AccountFrom
Transaction88 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult6 recursion level 1 with max 1
class ProcessingResult6{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult6 *-- "0..1" ResultData6 : ResultData
ProcessingResult6 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult6 *-- "0..0" Action9 : Action
ProcessingResult6 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult6 *-- "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
  

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

classDiagram
    class IOuterRecord
    VerificationResponseV01 --|> IOuterRecord : Implements
    VerificationResponseV01Document --|> IOuterDocument~VerificationResponseV01~ : Implements
    class IOuterDocument~VerificationResponseV01~ {
        VerificationResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    VerificationResponseV01Document *-- VerificationResponseV01 : 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.019.001.01">
    <VrfctnRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </VrfctnRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_qGCIhVgMEeedJb6VxsnkPg"
  nextVersions="_b47ZkYwFEeugeuahCxXQ-Q"
  name="VerificationResponseV01"
  definition="The VerificationResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a VerificationInitiation message."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="VrfctnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_qGCIiFgMEeedJb6VxsnkPg"
    nextVersions="_b47Zk4wFEeugeuahCxXQ-Q"
    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="_qGCIiVgMEeedJb6VxsnkPg"
    nextVersions="_b47ZlYwFEeugeuahCxXQ-Q"
    name="Body"
    definition="Information related to the verification response"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_IUYWcVgNEeedJb6VxsnkPg" />
  <messageBuildingBlock
    xmi:id="_qGCIhlgMEeedJb6VxsnkPg"
    nextVersions="_b47Zl4wFEeugeuahCxXQ-Q"
    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="019"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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