InquiryInitiationV01

cain.016.001.01

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

classDiagram
   direction tb
%% InquiryInitiation1 recursion level 0 with max 1
class InquiryInitiation1{
    ICCRelatedData IsoMax10KHexBinaryText
}
InquiryInitiation1 *-- "1..1" Environment12 : Environment
InquiryInitiation1 *-- "1..1" Context5 : Context
InquiryInitiation1 *-- "1..1" Transaction105 : Transaction
InquiryInitiation1 *-- "0..1" ProcessingResult5 : ProcessingResult
InquiryInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
InquiryInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment12 recursion level 1 with max 1
Environment12 *-- "1..1" PartyIdentification197 : Acquirer
Environment12 *-- "0..1" PartyIdentification197 : Sender
Environment12 *-- "0..1" PartyIdentification197 : Receiver
Environment12 *-- "1..1" PartyIdentification203 : Acceptor
Environment12 *-- "0..1" Terminal1 : Terminal
Environment12 *-- "1..1" CardData1 : Card
Environment12 *-- "0..1" CustomerDevice2 : CustomerDevice
Environment12 *-- "0..1" Wallet1 : Wallet
Environment12 *-- "0..1" Token1 : Token
Environment12 *-- "0..1" Cardholder15 : Cardholder
%% 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
%% Transaction105 recursion level 1 with max 1
class Transaction105{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    TransactionCurrency ISO3NumericCurrencyCode
    TransactionDescription IsoMax1000Text
}
Transaction105 *-- "0..0" AdditionalService1 : AdditionalService
Transaction105 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction105 *-- "1..1" TransactionIdentification11 : TransactionIdentification
Transaction105 *-- "0..0" DetailedAmount20 : DetailedAmount
Transaction105 *-- "0..1" Amount4 : ReconciliationAmount
Transaction105 *-- "0..0" AdditionalAmounts2 : AdditionalAmounts
Transaction105 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction105 *-- "0..1" AccountDetails2 : AccountFrom
Transaction105 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult5 recursion level 1 with max 1
class ProcessingResult5{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult5 *-- "0..1" ResultData1 : ResultData
ProcessingResult5 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult5 *-- "0..0" Action9 : Action
ProcessingResult5 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult5 *-- "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
  

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

classDiagram
    class IOuterRecord
    InquiryInitiationV01 --|> IOuterRecord : Implements
    InquiryInitiationV01Document --|> IOuterDocument~InquiryInitiationV01~ : Implements
    class IOuterDocument~InquiryInitiationV01~ {
        InquiryInitiationV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    InquiryInitiationV01Document *-- InquiryInitiationV01 : 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.01">
    <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="_ggro1VdREeeIAMBcVOw01w"
  nextVersions="_-dDCgYEQEeu6D49Gi-ZPwQ"
  name="InquiryInitiationV01"
  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="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="NqryInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ggro11dREeeIAMBcVOw01w"
    nextVersions="_-dDCg4EQEeu6D49Gi-ZPwQ"
    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="_ggro2FdREeeIAMBcVOw01w"
    nextVersions="_-dDChYEQEeu6D49Gi-ZPwQ"
    name="Body"
    definition="Information related to the inquiry initiation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_NT3jwVdTEeeIAMBcVOw01w" />
  <messageBuildingBlock
    xmi:id="_ggro1ldREeeIAMBcVOw01w"
    nextVersions="_-dDCh4EQEeu6D49Gi-ZPwQ"
    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="01" />
</messageDefinition>

ISO Building Blocks

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