AuthorisationResponseV02

cain.002.001.02

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
%% AuthorisationResponseV02 recursion level 0 with max 0
AuthorisationResponseV02 *-- "1..1" Header42 : Header
AuthorisationResponseV02 *-- "1..1" AuthorisationResponse1 : Body
AuthorisationResponseV02 *-- "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 response. Information related to the response of an authorisation initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AuthorisationResponse1 recursion level 0 with max 1
class AuthorisationResponse1{
    ICCRelatedData IsoMax10KHexBinaryText
}
AuthorisationResponse1 *-- "1..1" Environment2 : Environment
AuthorisationResponse1 *-- "0..1" Context2 : Context
AuthorisationResponse1 *-- "1..1" Transaction78 : Transaction
AuthorisationResponse1 *-- "0..1" AddendumData2 : AddendumData
AuthorisationResponse1 *-- "1..1" ProcessingResult2 : ProcessingResult
AuthorisationResponse1 *-- "0..0" ProtectedData1 : ProtectedData
AuthorisationResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment2 recursion level 1 with max 1
Environment2 *-- "1..1" PartyIdentification197 : Acquirer
Environment2 *-- "0..1" PartyIdentification197 : Sender
Environment2 *-- "0..1" PartyIdentification197 : Receiver
Environment2 *-- "0..1" PartyIdentification197 : Acceptor
Environment2 *-- "0..1" Terminal2 : Terminal
Environment2 *-- "0..1" CardData4 : Card
Environment2 *-- "0..1" Wallet1 : Wallet
Environment2 *-- "0..1" Token1 : Token
%% Context2 recursion level 1 with max 1
Context2 *-- "0..1" PointOfServiceContext1 : PointOfServiceContext
Context2 *-- "0..1" TransactionContext3 : TransactionContext
Context2 *-- "0..0" Verification2 : Verification
Context2 *-- "0..1" RiskContext1 : RiskContext
%% Transaction78 recursion level 1 with max 1
class Transaction78{
    TransactionType IsoExact2AlphaNumericText
    TransactionSubType IsoMax35Text
    TransactionAttribute TransactionAttribute1Code
    OtherTransactionAttribute IsoMax35Text
    PreAuthorisationTimeLimit IsoMax6NumericText
    AssociatedDataDestination IsoMax35Text
    TransactionDescription IsoMax1000Text
}
Transaction78 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction78 *-- "1..1" TransactionIdentification8 : TransactionIdentification
Transaction78 *-- "1..1" TransactionAmounts1 : TransactionAmounts
Transaction78 *-- "0..0" AdditionalAmounts1 : AdditionalAmounts
Transaction78 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction78 *-- "0..0" AdditionalFee1 : OriginalAdditionalFees
Transaction78 *-- "0..0" AccountBalance1 : AccountBalance
Transaction78 *-- "0..1" AccountDetails2 : AccountFrom
Transaction78 *-- "0..1" AccountDetails2 : AccountTo
Transaction78 *-- "0..0" AdditionalData1 : AdditionalData
%% AddendumData2 recursion level 1 with max 1
AddendumData2 *-- "0..1" FleetData3 : Fleet
AddendumData2 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult2 recursion level 1 with max 1
class ProcessingResult2{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult2 *-- "0..1" ApprovalData1 : ApprovalData
ProcessingResult2 *-- "0..1" ResultData1 : ResultData
ProcessingResult2 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult2 *-- "0..0" Action9 : Action
ProcessingResult2 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult2 *-- "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
  

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

classDiagram
    class IOuterRecord
    AuthorisationResponseV02 --|> IOuterRecord : Implements
    AuthorisationResponseV02Document --|> IOuterDocument~AuthorisationResponseV02~ : Implements
    class IOuterDocument~AuthorisationResponseV02~ {
        AuthorisationResponseV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AuthorisationResponseV02Document *-- AuthorisationResponseV02 : 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.02">
    <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="_El96hVKoEeeXvpI8ztnTow"
  nextVersions="_QYAiAYdNEeuBS50MFjViNw"
  previousVersion="_YO8QUHuOEeSVeNXcmBQ4hQ"
  name="AuthorisationResponseV02"
  definition="The AuthorisationResponse message is sent by an issuer or an agent to an acquirer in response to an AuthorisationInitiation message."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="AuthstnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_El96h1KoEeeXvpI8ztnTow"
    nextVersions="_QYAiA4dNEeuBS50MFjViNw"
    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="_El96iFKoEeeXvpI8ztnTow"
    nextVersions="_QYAiBYdNEeuBS50MFjViNw"
    name="Body"
    definition="Information related to the authorisation response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_FihUIE9MEeeg87n1YQSQ_A" />
  <messageBuildingBlock
    xmi:id="_El96iVKoEeeXvpI8ztnTow"
    nextVersions="_QYAiB4dNEeuBS50MFjViNw"
    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="02" />
</messageDefinition>

ISO Building Blocks

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