InquiryResponseV02

cain.017.001.02

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

Header60 members

Body building block

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

classDiagram
   direction tb
%% InquiryResponse2 recursion level 0 with max 1
class InquiryResponse2{
    ICCRelatedData IsoMax10KHexBinaryText
}
InquiryResponse2 *-- "1..1" Environment24 : Environment
InquiryResponse2 *-- "1..1" Context13 : Context
InquiryResponse2 *-- "1..1" Transaction132 : Transaction
InquiryResponse2 *-- "0..1" AddendumData5 : AddendumData
InquiryResponse2 *-- "1..1" ProcessingResult17 : ProcessingResult
InquiryResponse2 *-- "0..0" ProtectedData1 : ProtectedData
InquiryResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment24 recursion level 1 with max 1
Environment24 *-- "1..1" PartyIdentification263 : Acquirer
Environment24 *-- "0..1" PartyIdentification263 : Originator
Environment24 *-- "0..1" PartyIdentification263 : Sender
Environment24 *-- "0..1" PartyIdentification263 : Receiver
Environment24 *-- "1..1" PartyIdentification255 : Acceptor
Environment24 *-- "0..1" PartyIdentification263 : Destination
Environment24 *-- "0..1" Terminal6 : Terminal
Environment24 *-- "0..1" PartyIdentification263 : Issuer
Environment24 *-- "1..1" CardData9 : Card
Environment24 *-- "0..1" Wallet2 : Wallet
Environment24 *-- "0..1" Token2 : Token
Environment24 *-- "0..1" Cardholder19 : Cardholder
%% Context13 recursion level 1 with max 1
Context13 *-- "0..1" PointOfServiceContext4 : PointOfServiceContext
Context13 *-- "0..1" TransactionContext8 : TransactionContext
Context13 *-- "0..0" Verification4 : Verification
Context13 *-- "0..1" RiskContext2 : RiskContext
%% Transaction132 recursion level 1 with max 1
class Transaction132{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction132 *-- "0..0" AdditionalService2 : AdditionalService
Transaction132 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction132 *-- "1..1" TransactionIdentification18 : TransactionIdentification
Transaction132 *-- "0..1" Amount15 : ReconciliationAmount
Transaction132 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction132 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction132 *-- "0..0" AccountBalance2 : AccountBalance
Transaction132 *-- "0..0" AccountStatementData2 : AccountStatementData
Transaction132 *-- "0..1" AccountDetails3 : AccountFrom
Transaction132 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData5 recursion level 1 with max 1
AddendumData5 *-- "0..1" Instalment4 : Instalment
AddendumData5 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult17 recursion level 1 with max 1
class ProcessingResult17{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult17 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult17 *-- "1..1" ResultData7 : ResultData
ProcessingResult17 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult17 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult17 *-- "0..0" Action13 : Action
ProcessingResult17 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult17 *-- "0..0" AdditionalInformation29 : 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
  

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

classDiagram
    class IOuterRecord
    InquiryResponseV02 --|> IOuterRecord : Implements
    InquiryResponseV02Document --|> IOuterDocument~InquiryResponseV02~ : Implements
    class IOuterDocument~InquiryResponseV02~ {
        InquiryResponseV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    InquiryResponseV02Document *-- InquiryResponseV02 : 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.017.001.02">
    <NqryRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </NqryRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_xBSuIYaZEeuSbct6WWD-Ng"
  previousVersion="_J4V1pVfjEeeg8PDQoAs78Q"
  name="InquiryResponseV02"
  definition="The InquiryResponse message is sent by an issuer or an agent to an acquirer in response to an  InquiryInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="NqryRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_xBSuI4aZEeuSbct6WWD-Ng"
    previousVersion="_J4V1p1fjEeeg8PDQoAs78Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_x3IU4RvREey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_xBSuJYaZEeuSbct6WWD-Ng"
    previousVersion="_J4V1qVfjEeeg8PDQoAs78Q"
    name="Body"
    definition="Information related to the inquiry response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_i4m8MYaZEeuSbct6WWD-Ng" />
  <messageBuildingBlock
    xmi:id="_xBSuJ4aZEeuSbct6WWD-Ng"
    previousVersion="_J4V1qFfjEeeg8PDQoAs78Q"
    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="017"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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