AdministrativeResponseV01

caad.009.001.01

The AdministrativeResponse message is usually sent by any party (processor, clearing or settlement agent) to any party in response to a AdministrativeInitiation 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
%% AdministrativeResponseV01 recursion level 0 with max 0
AdministrativeResponseV01 *-- "1..1" Header66 : Header
AdministrativeResponseV01 *-- "1..1" AdministrativeResponse1 : Body
AdministrativeResponseV01 *-- "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. Header for a fee collection message. ISO 8583 MTI For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header66 recursion level 0 with max 1
class Header66{
    MessageFunction MessageFunction29Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header66 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header66 *-- "1..1" GenericIdentification183 : InitiatingParty
Header66 *-- "0..1" GenericIdentification183 : RecipientParty
Header66 *-- "0..0" AdditionalData1 : TraceData
Header66 *-- "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
  

Header66 members

Body building block

Information related to the Administrative Response. Information related to the Administrative initiation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdministrativeResponse1 recursion level 0 with max 1
class AdministrativeResponse1{
    ICCRelatedData IsoMax10KHexBinaryText
}
AdministrativeResponse1 *-- "1..1" Environment34 : Environment
AdministrativeResponse1 *-- "0..1" Context18 : Context
AdministrativeResponse1 *-- "1..1" Transaction144 : Transaction
AdministrativeResponse1 *-- "0..0" OriginalTransaction2 : OriginalTransaction
AdministrativeResponse1 *-- "0..1" AddendumData3 : AddendumData
AdministrativeResponse1 *-- "0..0" AdditionalData2 : AdditionalData
AdministrativeResponse1 *-- "1..1" ProcessingResult17 : ProcessingResult
AdministrativeResponse1 *-- "0..0" ProtectedData1 : ProtectedData
AdministrativeResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment34 recursion level 1 with max 1
Environment34 *-- "0..1" PartyIdentification263 : Acquirer
Environment34 *-- "0..1" PartyIdentification263 : Originator
Environment34 *-- "0..1" PartyIdentification263 : Sender
Environment34 *-- "0..1" PartyIdentification263 : Receiver
Environment34 *-- "0..1" PartyIdentification255 : Acceptor
Environment34 *-- "0..1" PartyIdentification263 : Destination
Environment34 *-- "0..1" PartyIdentification257 : Payer
Environment34 *-- "0..1" PartyIdentification257 : Payee
Environment34 *-- "0..1" Terminal4 : Terminal
Environment34 *-- "0..1" PartyIdentification263 : Issuer
Environment34 *-- "0..1" CardData6 : Card
Environment34 *-- "0..1" CustomerDevice4 : CustomerDevice
Environment34 *-- "0..1" Wallet2 : Wallet
Environment34 *-- "0..1" Token2 : Token
Environment34 *-- "0..1" Cardholder19 : Cardholder
Environment34 *-- "0..0" AdditionalData2 : AdditionalData
%% Context18 recursion level 1 with max 1
Context18 *-- "0..1" PointOfServiceContext3 : PointOfServiceContext
Context18 *-- "0..1" TransactionContext7 : TransactionContext
Context18 *-- "0..0" Verification5 : Verification
Context18 *-- "0..0" RiskContext2 : RiskContext
Context18 *-- "0..1" SaleContext8 : SaleContext
Context18 *-- "0..0" AdditionalData2 : AdditionalData
%% Transaction144 recursion level 1 with max 1
class Transaction144{
    AdministrativeType AdministrativeType1Code
    OtherAdministrativeType IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    AssociatedDataIndicator IsoTrueFalseIndicator
    AssociatedDataReference IsoMax70Text
    AssociatedDataDestination IsoMax35Text
    TextMessage IsoMax20KText
    TransactionDescription IsoMax1000Text
}
Transaction144 *-- "0..0" AdditionalService2 : AdditionalService
Transaction144 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction144 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction144 *-- "0..0" LocalData9 : LocalData
Transaction144 *-- "0..0" AdditionalData2 : AdditionalData
%% OriginalTransaction2 recursion level 1 with max 1
OriginalTransaction2 *-- "0..1" Environment20 : Environment
OriginalTransaction2 *-- "0..1" Context12 : Context
OriginalTransaction2 *-- "0..1" Transaction147 : Transaction
OriginalTransaction2 *-- "0..1" ProcessingResult10 : ProcessingResult
%% AddendumData3 recursion level 1 with max 1
class AddendumData3{
    PurchaseIdentifierType PurchaseIdentifierType1Code
    OtherPurchaseIdentifierType IsoMax35Text
    PurchaseIdentifier IsoMax99Text
}
AddendumData3 *-- "0..1" AdditionalAcceptorData1 : AdditionalAcceptorData
AddendumData3 *-- "0..1" Customer4 : Customer
AddendumData3 *-- "0..1" Sale2 : Sale
AddendumData3 *-- "0..1" FleetData4 : Fleet
AddendumData3 *-- "0..1" Invoice2 : Invoice
AddendumData3 *-- "0..0" TravelAgency3 : TravelAgency
AddendumData3 *-- "0..1" PassengerTransport2 : PassengerTransport
AddendumData3 *-- "0..0" VehicleRentalService2 : VehicleRental
AddendumData3 *-- "0..0" Lodging3 : Lodging
AddendumData3 *-- "0..1" ShippingData2 : ShippingData
AddendumData3 *-- "0..1" TelecomServices2 : TelecommunicationServices
AddendumData3 *-- "0..0" TemporaryServices2 : TemporaryServices
AddendumData3 *-- "0..1" Instalment4 : Instalment
AddendumData3 *-- "0..0" AdditionalData1 : AdditionalData
%% AdditionalData2 recursion level 1 with max 1
class AdditionalData2{
    Type IsoMax35Text
}
AdditionalData2 *-- "0..0" AdditionalData1 : Details
%% ProcessingResult17 recursion level 1 with max 1
class ProcessingResult17{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult17 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult17 *-- "1..1" ResultData7 : ResultData
ProcessingResult17 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult17 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult17 *-- "0..0" Action13 : Action
ProcessingResult17 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult17 *-- "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
  

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

classDiagram
    class IOuterRecord
    AdministrativeResponseV01 --|> IOuterRecord : Implements
    AdministrativeResponseV01Document --|> IOuterDocument~AdministrativeResponseV01~ : Implements
    class IOuterDocument~AdministrativeResponseV01~ {
        AdministrativeResponseV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AdministrativeResponseV01Document *-- AdministrativeResponseV01 : 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:caad.009.001.01">
    <AdmstvRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AdmstvRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_4xvBUDNQEeylu6lH-gut-A"
  name="AdministrativeResponseV01"
  definition="The AdministrativeResponse message is usually sent by any party (processor, clearing or settlement agent) to any party in response to a AdministrativeInitiation Message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="AdmstvRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ijx78TNREeylu6lH-gut-A"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_aRA58RynEeyVgKPonV4SjQ" />
  <messageBuildingBlock
    xmi:id="_KMg-cDZ4EeysP8L3U1Ot-g"
    name="Body"
    definition="Information related to the Administrative Response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_wdv6MTZ3EeysP8L3U1Ot-g" />
  <messageBuildingBlock
    xmi:id="_jWqxcTNREeylu6lH-gut-A"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="caad"
    messageFunctionality="009"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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