Iso20022

AcquirerFinancialInitiation

cain.003.001.01

The AcquirerFinancialInitiation message is sent by an acquirer or an agent to an issuer or an agent, to request, advice or notify the approval and the clearing of a card transaction.

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
%% AcquirerFinancialInitiation recursion level 0 with max 0
AcquirerFinancialInitiation *-- "1..1" Header17 : Header
AcquirerFinancialInitiation *-- "1..1" AcquirerFinancialInitiation1 : FinancialInitiation
AcquirerFinancialInitiation *-- "1..1" ContentInformationType15 : SecurityTrailer

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Information related to the protocol management. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header17 recursion level 0 with max 1
class Header17{
    MessageFunction MessageFunction6Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header17 *-- "1..1" GenericIdentification73 : InitiatingParty
Header17 *-- "0..1" GenericIdentification73 : RecipientParty
Header17 *-- "0..0" Traceability3 : Traceability
%% GenericIdentification73 recursion level 1 with max 1
class GenericIdentification73{
    Identification IsoMax35Text
    Type PartyType9Code
    Issuer PartyType9Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification73 recursion level 1 with max 1
class GenericIdentification73{
    Identification IsoMax35Text
    Type PartyType9Code
    Issuer PartyType9Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% Traceability3 recursion level 1 with max 1
class Traceability3{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability3 *-- "1..1" GenericIdentification74 : RelayIdentification

Header17 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction6Code - Required 1..1
ProtocolVersion Version of the acquirer to issuer protocol specifications. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoMax3NumericText - Required 1..1
ReTransmissionCounter Number of retransmission of the message. Incremented by one for each retransmission. IsoMax3NumericText - Optional 0..1
CreationDateTime Date and time at which the message was sent. IsoISODateTime - Required 1..1
InitiatingParty Unique identification of the partner that has initiated the exchange. GenericIdentification73 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification73 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability3 - Unknown 0..0

FinancialInitiation building block

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

classDiagram
   direction tb
%% AcquirerFinancialInitiation1 recursion level 0 with max 1
AcquirerFinancialInitiation1 *-- "1..1" CardTransactionEnvironment1 : Environment
AcquirerFinancialInitiation1 *-- "1..1" CardTransactionContext1 : Context
AcquirerFinancialInitiation1 *-- "1..1" CardTransaction5 : Transaction
%% CardTransactionEnvironment1 recursion level 1 with max 1
class CardTransactionEnvironment1{
    CardSchemeIdentification IsoMax35Text
}
CardTransactionEnvironment1 *-- "1..1" Acquirer6 : Acquirer
CardTransactionEnvironment1 *-- "0..1" Organisation18 : Acceptor
CardTransactionEnvironment1 *-- "0..1" CardAcceptorTerminal1 : Terminal
CardTransactionEnvironment1 *-- "1..1" PaymentCard12 : Card
CardTransactionEnvironment1 *-- "0..1" CustomerDevice1 : CustomerDevice
CardTransactionEnvironment1 *-- "0..1" CustomerDevice1 : Wallet
CardTransactionEnvironment1 *-- "0..1" CardPaymentToken4 : PaymentToken
CardTransactionEnvironment1 *-- "0..1" Cardholder9 : Cardholder
CardTransactionEnvironment1 *-- "0..1" ContentInformationType10 : ProtectedCardholderData
%% CardTransactionContext1 recursion level 1 with max 1
CardTransactionContext1 *-- "1..1" CardTransactionContext2 : TransactionContext
CardTransactionContext1 *-- "0..1" SaleContext1 : SaleContext
%% CardTransaction5 recursion level 1 with max 1
class CardTransaction5{
    TransactionType CardPaymentServiceType7Code
    AdditionalService CardPaymentServiceType8Code
    ServiceAttribute CardPaymentServiceType3Code
    MerchantCategoryCode IsoMin3Max4NumericText
    AcceptorTransactionDateTime IsoISODateTime
    AcceptorTransactionIdentification IsoMax35Text
    InitiatorTransactionIdentification IsoMax35Text
    TransactionLifeCycleIdentification IsoMax35Text
    TransactionLifeCycleSequenceNumber IsoNumber
    TransactionLifeCycleSequenceCounter IsoNumber
    AcquirerTransactionReference IsoMax35NumericText
    CardIssuerReferenceData IsoMax140Text
}
CardTransaction5 *-- "0..1" TransactionIdentifier2 : Reconciliation
CardTransaction5 *-- "0..1" CardTransaction3 : OriginalTransaction
CardTransaction5 *-- "1..1" CardTransactionDetail3 : TransactionDetails
CardTransaction5 *-- "0..1" AuthorisationResult7 : AuthorisationResult

AcquirerFinancialInitiation1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardTransactionEnvironment1 - Required 1..1
Context Context in which the transaction is performed. CardTransactionContext1 - Required 1..1
Transaction Card transaction for which the financial authorisation has been requested. CardTransaction5 - Required 1..1

SecurityTrailer building block

Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
    ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType15 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType2Code - Required 1..1
AuthenticatedData Data protection by a message authentication code (MAC). AuthenticatedData4 - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the AcquirerFinancialInitiation implementation follows a specific implementaiton pattern. First of all, AcquirerFinancialInitiation impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcquirerFinancialInitiationDocument implements IOuterDocument. Because AcquirerFinancialInitiation implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcquirerFinancialInitiation.

classDiagram
    class IOuterRecord
    AcquirerFinancialInitiation --|> IOuterRecord : Implements
    AcquirerFinancialInitiationDocument --|> IOuterDocument~AcquirerFinancialInitiation~ : Implements
    class IOuterDocument~AcquirerFinancialInitiation~ {
        AcquirerFinancialInitiation Message
     }

Document wrapper for serialization

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

classDiagram
    AcquirerFinancialInitiationDocument *-- AcquirerFinancialInitiation : 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.003.001.01">
    <AcqrrFinInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <FinInitn>
            <!-- FinancialInitiation inner content -->
        </FinInitn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AcqrrFinInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Mdr84HubEeSBS-QFUaKA-g"
  nextVersions="_TwBNBVTQEeeeIYOiLZFQGg"
  name="AcquirerFinancialInitiation"
  definition="The AcquirerFinancialInitiation message is sent by an acquirer or an agent to an issuer or an agent, to request, advice or notify the approval and the clearing of a card transaction."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AcqrrFinInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_kgOI0HubEeSBS-QFUaKA-g"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_l60LgXq_EeSA34QF-FhTBw" />
  <messageBuildingBlock
    xmi:id="_uR7TcHubEeSBS-QFUaKA-g"
    name="FinancialInitiation"
    definition="Information related to financial authorisation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="FinInitn"
    complexType="_oCk1QHubEeSBS-QFUaKA-g" />
  <messageBuildingBlock
    xmi:id="_Fxvz4HucEeSBS-QFUaKA-g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
  <messageDefinitionIdentifier
    businessArea="cain"
    messageFunctionality="003"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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