InquiryInitiationV02

cain.016.001.02

The InquiryInitiation message is sent by an acquirer or agent to an issuer to request information related to the card (e.g. about a cardholder, the availability of funds, etc.).

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
%% InquiryInitiationV02 recursion level 0 with max 0
InquiryInitiationV02 *-- "1..1" Header60 : Header
InquiryInitiationV02 *-- "1..1" InquiryInitiation2 : Body
InquiryInitiationV02 *-- "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 initiation. Information related to the inquiry initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InquiryInitiation2 recursion level 0 with max 1
class InquiryInitiation2{
    ICCRelatedData IsoMax10KHexBinaryText
}
InquiryInitiation2 *-- "1..1" Environment18 : Environment
InquiryInitiation2 *-- "1..1" Context11 : Context
InquiryInitiation2 *-- "1..1" Transaction131 : Transaction
InquiryInitiation2 *-- "0..1" AddendumData5 : AddendumData
InquiryInitiation2 *-- "0..1" ProcessingResult11 : ProcessingResult
InquiryInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
InquiryInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment18 recursion level 1 with max 1
Environment18 *-- "1..1" PartyIdentification263 : Acquirer
Environment18 *-- "0..1" PartyIdentification263 : Originator
Environment18 *-- "0..1" PartyIdentification263 : Sender
Environment18 *-- "0..1" PartyIdentification263 : Receiver
Environment18 *-- "1..1" PartyIdentification255 : Acceptor
Environment18 *-- "0..1" PartyIdentification263 : Destination
Environment18 *-- "0..1" Terminal4 : Terminal
Environment18 *-- "0..1" PartyIdentification263 : Issuer
Environment18 *-- "0..1" CardData6 : Card
Environment18 *-- "0..1" CustomerDevice4 : CustomerDevice
Environment18 *-- "0..1" Wallet2 : Wallet
Environment18 *-- "0..1" Token2 : Token
Environment18 *-- "0..1" Cardholder19 : Cardholder
%% Context11 recursion level 1 with max 1
Context11 *-- "1..1" PointOfServiceContext3 : PointOfServiceContext
Context11 *-- "1..1" TransactionContext7 : TransactionContext
Context11 *-- "0..0" Verification5 : Verification
Context11 *-- "0..1" RiskContext2 : RiskContext
%% Transaction131 recursion level 1 with max 1
class Transaction131{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    TransactionCurrency ISO3NumericCurrencyCode
    TransactionDescription IsoMax1000Text
}
Transaction131 *-- "0..0" AdditionalService2 : AdditionalService
Transaction131 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction131 *-- "1..1" TransactionIdentification18 : TransactionIdentification
Transaction131 *-- "0..0" DetailedAmount23 : DetailedAmount
Transaction131 *-- "0..1" Amount15 : ReconciliationAmount
Transaction131 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction131 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction131 *-- "0..1" AccountDetails3 : AccountFrom
Transaction131 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData5 recursion level 1 with max 1
AddendumData5 *-- "0..1" Instalment4 : Instalment
AddendumData5 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult11 recursion level 1 with max 1
class ProcessingResult11{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult11 *-- "0..1" ResultData7 : ResultData
ProcessingResult11 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult11 *-- "0..0" Action13 : Action
ProcessingResult11 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult11 *-- "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
  

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

classDiagram
    class IOuterRecord
    InquiryInitiationV02 --|> IOuterRecord : Implements
    InquiryInitiationV02Document --|> IOuterDocument~InquiryInitiationV02~ : Implements
    class IOuterDocument~InquiryInitiationV02~ {
        InquiryInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    InquiryInitiationV02Document *-- InquiryInitiationV02 : 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.016.001.02">
    <NqryInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </NqryInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_-dDCgYEQEeu6D49Gi-ZPwQ"
  previousVersion="_ggro1VdREeeIAMBcVOw01w"
  name="InquiryInitiationV02"
  definition="The InquiryInitiation message is sent by an acquirer or agent to an issuer to request information related to the card (e.g. about a cardholder, the availability of funds, etc.)."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="NqryInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_-dDCg4EQEeu6D49Gi-ZPwQ"
    previousVersion="_ggro11dREeeIAMBcVOw01w"
    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="_-dDChYEQEeu6D49Gi-ZPwQ"
    previousVersion="_ggro2FdREeeIAMBcVOw01w"
    name="Body"
    definition="Information related to the inquiry initiation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_FSdbIYEREeu6D49Gi-ZPwQ" />
  <messageBuildingBlock
    xmi:id="_-dDCh4EQEeu6D49Gi-ZPwQ"
    previousVersion="_ggro1ldREeeIAMBcVOw01w"
    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="016"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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