AuthorisationInitiationV02

cain.001.001.02

AuthorisationInitiation message is sent by an acquirer or an agent to an issuer to request approval of a card transaction by the issuer or to inform the issuer about the completion of the authorisation. It can also be sent by an issuer to an acquirer or agent to advise about the result of an authorisation already performed.

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
%% AuthorisationInitiationV02 recursion level 0 with max 0
AuthorisationInitiationV02 *-- "1..1" Header42 : Header
AuthorisationInitiationV02 *-- "1..1" AuthorisationInitiation1 : Body
AuthorisationInitiationV02 *-- "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
%% Header42 recursion level 0 with max 1
class Header42{
    MessageFunction MessageFunction16Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header42 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header42 *-- "1..1" GenericIdentification172 : InitiatingParty
Header42 *-- "0..1" GenericIdentification172 : RecipientParty
Header42 *-- "0..0" AdditionalData1 : TraceData
Header42 *-- "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
  

Header42 members

Body building block

Information related to the authorisation initiation. Information related to the authorisation initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AuthorisationInitiation1 recursion level 0 with max 1
class AuthorisationInitiation1{
    ICCRelatedData IsoMax10KHexBinaryText
}
AuthorisationInitiation1 *-- "1..1" Environment1 : Environment
AuthorisationInitiation1 *-- "1..1" Context1 : Context
AuthorisationInitiation1 *-- "1..1" Transaction77 : Transaction
AuthorisationInitiation1 *-- "0..1" AddendumData1 : AddendumData
AuthorisationInitiation1 *-- "0..1" ProcessingResult1 : ProcessingResult
AuthorisationInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
AuthorisationInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment1 recursion level 1 with max 1
Environment1 *-- "1..1" PartyIdentification197 : Acquirer
Environment1 *-- "0..1" PartyIdentification197 : Sender
Environment1 *-- "0..1" PartyIdentification197 : Receiver
Environment1 *-- "0..1" PartyIdentification203 : Acceptor
Environment1 *-- "0..1" PartyIdentification211 : Payer
Environment1 *-- "0..1" PartyIdentification211 : Payee
Environment1 *-- "0..1" Terminal1 : Terminal
Environment1 *-- "1..1" CardData1 : Card
Environment1 *-- "0..1" CustomerDevice2 : CustomerDevice
Environment1 *-- "0..1" Wallet1 : Wallet
Environment1 *-- "0..1" Token1 : Token
Environment1 *-- "0..1" Cardholder15 : Cardholder
%% Context1 recursion level 1 with max 1
Context1 *-- "1..1" PointOfServiceContext1 : PointOfServiceContext
Context1 *-- "1..1" TransactionContext1 : TransactionContext
Context1 *-- "0..0" Verification1 : Verification
Context1 *-- "0..0" RiskContext1 : RiskContext
Context1 *-- "0..1" SaleContext7 : SaleContext
%% Transaction77 recursion level 1 with max 1
class Transaction77{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute1Code
    OtherTransactionAttribute IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    PreAuthorisationTimeLimit IsoMax6NumericText
    AssociatedDataIndicator IsoTrueFalseIndicator
    AssociatedDataReference IsoMax70Text
    AssociatedDataDestination IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction77 *-- "0..0" AdditionalService1 : AdditionalService
Transaction77 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction77 *-- "1..1" TransactionIdentification8 : TransactionIdentification
Transaction77 *-- "0..0" DisputeData1 : DisputeData
Transaction77 *-- "1..1" TransactionAmounts1 : TransactionAmounts
Transaction77 *-- "0..0" AdditionalAmounts1 : AdditionalAmounts
Transaction77 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction77 *-- "0..0" AdditionalFee1 : OriginalAdditionalFees
Transaction77 *-- "0..0" DepositDetails1 : DepositDetails
Transaction77 *-- "0..1" FundingService1 : FundsServices
Transaction77 *-- "0..1" AccountDetails2 : AccountFrom
Transaction77 *-- "0..1" AccountDetails2 : AccountTo
Transaction77 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData1 recursion level 1 with max 1
class AddendumData1{
    PurchaseIdentifierType PurchaseIdentifierType1Code
    OtherPurchaseIdentifierType IsoMax35Text
    PurchaseIdentifier IsoMax99Text
}
AddendumData1 *-- "0..1" AdditionalAcceptorData1 : AdditionalAcceptorData
AddendumData1 *-- "0..1" Customer4 : Customer
AddendumData1 *-- "0..1" Sale1 : Sale
AddendumData1 *-- "0..1" FleetData2 : Fleet
AddendumData1 *-- "0..1" Invoice1 : Invoice
AddendumData1 *-- "0..1" TravelAgency2 : TravelAgency
AddendumData1 *-- "0..1" PassengerTransport1 : PassengerTransport
AddendumData1 *-- "0..0" VehicleRentalService1 : VehicleRental
AddendumData1 *-- "0..0" Lodging2 : Lodging
AddendumData1 *-- "0..1" ShippingData1 : ShippingData
AddendumData1 *-- "0..1" TelecomServices1 : TelecommunicationServices
AddendumData1 *-- "0..0" TemporaryServices1 : TemporaryServices
AddendumData1 *-- "0..1" Instalment3 : Instalment
AddendumData1 *-- "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
  

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

classDiagram
    class IOuterRecord
    AuthorisationInitiationV02 --|> IOuterRecord : Implements
    AuthorisationInitiationV02Document --|> IOuterDocument~AuthorisationInitiationV02~ : Implements
    class IOuterDocument~AuthorisationInitiationV02~ {
        AuthorisationInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AuthorisationInitiationV02Document *-- AuthorisationInitiationV02 : 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.001.001.02">
    <AuthstnInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AuthstnInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_SBa-kFKeEeeFcfYfFkVztg"
  nextVersions="_eVcboYEKEeu6D49Gi-ZPwQ"
  previousVersion="_Kdha0Hq9EeSqmf43GdBXXQ"
  name="AuthorisationInitiationV02"
  definition="AuthorisationInitiation message is sent by an acquirer or an agent to an issuer to request approval of a card transaction by the issuer or to inform the issuer about the completion of the authorisation. It can also be sent by an issuer to an acquirer or agent to advise about the result of an authorisation already performed.&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="AuthstnInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_BfrOEFKfEeeFcfYfFkVztg"
    nextVersions="_eVcbo4EKEeu6D49Gi-ZPwQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_WZVX0VUAEeetiruPyDPo0Q" />
  <messageBuildingBlock
    xmi:id="_RkTIQFKfEeeFcfYfFkVztg"
    nextVersions="_eVcbpYEKEeu6D49Gi-ZPwQ"
    name="Body"
    definition="Information related to the authorisation initiation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_fl_dEE9MEeeg87n1YQSQ_A" />
  <messageBuildingBlock
    xmi:id="_e333IFKfEeeFcfYfFkVztg"
    nextVersions="_eVcbp4EKEeu6D49Gi-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="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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