AuthorisationResponseV03

cain.002.001.03

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

Header62 members

Body building block

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

classDiagram
   direction tb
%% AuthorisationResponse2 recursion level 0 with max 1
class AuthorisationResponse2{
    ICCRelatedData IsoMax10KHexBinaryText
}
AuthorisationResponse2 *-- "1..1" Environment26 : Environment
AuthorisationResponse2 *-- "0..1" Context13 : Context
AuthorisationResponse2 *-- "1..1" Transaction150 : Transaction
AuthorisationResponse2 *-- "0..1" AddendumData4 : AddendumData
AuthorisationResponse2 *-- "1..1" ProcessingResult10 : ProcessingResult
AuthorisationResponse2 *-- "0..0" ProtectedData1 : ProtectedData
AuthorisationResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment26 recursion level 1 with max 1
Environment26 *-- "1..1" PartyIdentification263 : Acquirer
Environment26 *-- "0..1" PartyIdentification263 : Originator
Environment26 *-- "0..1" PartyIdentification263 : Sender
Environment26 *-- "0..1" PartyIdentification263 : Receiver
Environment26 *-- "0..1" PartyIdentification258 : Acceptor
Environment26 *-- "0..1" PartyIdentification263 : Destination
Environment26 *-- "0..1" Terminal6 : Terminal
Environment26 *-- "0..1" PartyIdentification263 : Issuer
Environment26 *-- "0..1" CardData9 : Card
Environment26 *-- "0..1" Wallet2 : Wallet
Environment26 *-- "0..1" Token2 : Token
Environment26 *-- "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
%% Transaction150 recursion level 1 with max 1
class Transaction150{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute2Code
    OtherTransactionAttribute IsoMax35Text
    PreAuthorisationTimeLimit IsoMax6NumericText
    AssociatedDataDestination IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction150 *-- "0..0" AdditionalService2 : AdditionalService
Transaction150 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction150 *-- "1..1" TransactionIdentification51 : TransactionIdentification
Transaction150 *-- "1..1" TransactionAmounts2 : TransactionAmounts
Transaction150 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction150 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction150 *-- "0..0" AdditionalFee2 : OriginalAdditionalFee
Transaction150 *-- "0..0" AccountBalance2 : AccountBalance
Transaction150 *-- "0..1" AccountDetails3 : AccountFrom
Transaction150 *-- "0..1" AccountDetails3 : AccountTo
Transaction150 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData4 recursion level 1 with max 1
AddendumData4 *-- "0..1" FleetData5 : Fleet
AddendumData4 *-- "0..1" Instalment4 : Instalment
AddendumData4 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult10 recursion level 1 with max 1
class ProcessingResult10{
    ApprovalCode IsoExact6AlphaNumericText
    ActionRequired IsoYesNoIndicator
}
ProcessingResult10 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult10 *-- "1..1" ResultData7 : ResultData
ProcessingResult10 *-- "0..1" ErrorDetails2 : ErrorDetail
ProcessingResult10 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult10 *-- "0..0" Action13 : Action
ProcessingResult10 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult10 *-- "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
  

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

classDiagram
    class IOuterRecord
    AuthorisationResponseV03 --|> IOuterRecord : Implements
    AuthorisationResponseV03Document --|> IOuterDocument~AuthorisationResponseV03~ : Implements
    class IOuterDocument~AuthorisationResponseV03~ {
        AuthorisationResponseV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AuthorisationResponseV03Document *-- AuthorisationResponseV03 : 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.002.001.03">
    <AuthstnRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AuthstnRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_QYAiAYdNEeuBS50MFjViNw"
  previousVersion="_El96hVKoEeeXvpI8ztnTow"
  name="AuthorisationResponseV03"
  definition="The AuthorisationResponse message is sent by an issuer or an agent to an acquirer in response to an AuthorisationInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="AuthstnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_QYAiA4dNEeuBS50MFjViNw"
    previousVersion="_El96h1KoEeeXvpI8ztnTow"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_yws50RvUEey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_QYAiBYdNEeuBS50MFjViNw"
    previousVersion="_El96iFKoEeeXvpI8ztnTow"
    name="Body"
    definition="Information related to the authorisation response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_Fi1vQYdNEeuBS50MFjViNw" />
  <messageBuildingBlock
    xmi:id="_QYAiB4dNEeuBS50MFjViNw"
    previousVersion="_El96iVKoEeeXvpI8ztnTow"
    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="002"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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