cain.003.001.03
The FinancialInitiation message is sent by an acquirer or an agent to an issuer to request approval of a card transaction or to inform about the completion of an authorisation. It allows the approved transaction amount to be billed or posted on the cardholder’s account. It can also be sent by an issuer to an acquirer or agent to advise that an authorisation has been successfully completed for the final amount and requests the clearing of the 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
%% FinancialInitiationV03 recursion level 0 with max 0
FinancialInitiationV03 *-- "1..1" Header62 : Header
FinancialInitiationV03 *-- "1..1" FinancialInitiation2 : Body
FinancialInitiationV03 *-- "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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction16Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax2048Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange of messages between two parties. | IsoMax35Text - Optional 0..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 |
| BatchManagementInformation | Information related to the batch and the collection to which the message belongs if any. | BatchManagementInformation1 - Optional 0..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification183 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification183 - Optional 0..1 |
| TraceData | Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability9 - Unknown 0..0 |
Body building block
Information related to the financial initiation. Information related to the financial initiation message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% FinancialInitiation2 recursion level 0 with max 1
class FinancialInitiation2{
ICCRelatedData IsoMax10KHexBinaryText
}
FinancialInitiation2 *-- "1..1" Environment17 : Environment
FinancialInitiation2 *-- "1..1" Context10 : Context
FinancialInitiation2 *-- "1..1" Transaction145 : Transaction
FinancialInitiation2 *-- "1..1" OriginalTransaction2 : OriginalTransaction
FinancialInitiation2 *-- "0..1" AddendumData3 : AddendumData
FinancialInitiation2 *-- "0..1" ProcessingResult16 : ProcessingResult
FinancialInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
FinancialInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment17 recursion level 1 with max 1
Environment17 *-- "1..1" PartyIdentification263 : Acquirer
Environment17 *-- "0..1" PartyIdentification263 : Originator
Environment17 *-- "0..1" PartyIdentification263 : Sender
Environment17 *-- "0..1" PartyIdentification263 : Receiver
Environment17 *-- "0..1" PartyIdentification255 : Acceptor
Environment17 *-- "0..1" PartyIdentification263 : Destination
Environment17 *-- "0..1" PartyIdentification257 : Payer
Environment17 *-- "0..1" PartyIdentification257 : Payee
Environment17 *-- "0..1" Terminal4 : Terminal
Environment17 *-- "0..1" PartyIdentification263 : Issuer
Environment17 *-- "0..1" CardData6 : Card
Environment17 *-- "0..1" CustomerDevice4 : CustomerDevice
Environment17 *-- "0..1" Wallet2 : Wallet
Environment17 *-- "0..1" Token2 : Token
Environment17 *-- "0..1" Cardholder19 : Cardholder
%% Context10 recursion level 1 with max 1
Context10 *-- "1..1" PointOfServiceContext3 : PointOfServiceContext
Context10 *-- "1..1" TransactionContext7 : TransactionContext
Context10 *-- "0..0" Verification5 : Verification
Context10 *-- "0..0" RiskContext2 : RiskContext
Context10 *-- "0..1" SaleContext8 : SaleContext
%% Transaction145 recursion level 1 with max 1
class Transaction145{
TransactionType ISO8583TransactionTypeCode
TransactionSubType IsoMax35Text
TransactionAttribute TransactionAttribute2Code
OtherTransactionAttribute IsoMax35Text
MessageReason ISO8583MessageReasonCode
AlternateMessageReason IsoMax256Text
PreAuthorisationTimeLimit IsoMax6NumericText
AssociatedDataIndicator IsoTrueFalseIndicator
AssociatedDataReference IsoMax70Text
AssociatedDataDestination IsoMax35Text
TransactionDescription IsoMax1000Text
}
Transaction145 *-- "0..0" AdditionalService2 : AdditionalService
Transaction145 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction145 *-- "1..1" TransactionIdentification16 : TransactionIdentification
Transaction145 *-- "0..0" DisputeData3 : DisputeData
Transaction145 *-- "1..1" TransactionAmounts2 : TransactionAmounts
Transaction145 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction145 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction145 *-- "0..0" AdditionalFee2 : OriginalAdditionalFee
Transaction145 *-- "0..0" DepositDetails2 : DepositDetails
Transaction145 *-- "0..1" FundingService2 : FundsServices
Transaction145 *-- "0..1" AccountDetails3 : AccountFrom
Transaction145 *-- "0..1" AccountDetails3 : AccountTo
Transaction145 *-- "0..0" AdditionalData1 : AdditionalData
Transaction145 *-- "0..1" AdditionalInformation20 : AdditionalInformation
%% 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
%% ProcessingResult16 recursion level 1 with max 1
class ProcessingResult16{
ApprovalCode IsoExact6AlphaNumericText
ActionRequired IsoYesNoIndicator
}
ProcessingResult16 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult16 *-- "0..1" ResultData7 : ResultData
ProcessingResult16 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult16 *-- "0..0" Action13 : Action
ProcessingResult16 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult16 *-- "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
FinancialInitiation2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | Environment17 - Required 1..1 |
| Context | Context in which the card transaction is performed. | Context10 - Required 1..1 |
| Transaction | Card transaction for which a financial process is requested. | Transaction145 - Required 1..1 |
| OriginalTransaction | Contains details of the transaction to be retrieved. | OriginalTransaction2 - Required 1..1 |
| AddendumData | Component contains data structures applicable to certain industries that require specific data within transaction messages. | AddendumData3 - Optional 0..1 |
| ProcessingResult | Outcome of the processing of the authorisation | ProcessingResult16 - Optional 0..1 |
| ICCRelatedData | Data related to an integrated circuit card application embedded in the payment card of the cardholder. ISO 8583 bit 55 | IsoMax10KHexBinaryText - Optional 0..1 |
| ProtectedData | Contains protected data and the attributes used to protect the data. | ProtectedData1 - Unknown 0..0 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or other specific block. | SupplementaryData1 - Unknown 0..0 |
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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MACData | Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 | MACData1 - Required 1..1 |
| MAC | Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 | IsoMax8HexBinaryText - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the FinancialInitiationV03 implementation follows a specific implementaiton pattern. First of all, FinancialInitiationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialInitiationV03Document implements IOuterDocument. Because FinancialInitiationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialInitiationV03.
classDiagram
class IOuterRecord
FinancialInitiationV03 --|> IOuterRecord : Implements
FinancialInitiationV03Document --|> IOuterDocument~FinancialInitiationV03~ : Implements
class IOuterDocument~FinancialInitiationV03~ {
FinancialInitiationV03 Message
}
Document wrapper for serialization
The only real purpose FinancialInitiationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cain.003.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FinancialInitiationV03.ToDocument() method. The returned FinancialInitiationV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FinancialInitiationV03Document *-- FinancialInitiationV03 : 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.03">
<FinInitn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</FinInitn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Sii_4YELEeu6D49Gi-ZPwQ"
previousVersion="_TwBNBVTQEeeeIYOiLZFQGg"
name="FinancialInitiationV03"
definition="The FinancialInitiation message is sent by an acquirer or an agent to an issuer to request approval of a card transaction or to inform about the completion of an authorisation. It allows the approved transaction amount to be billed or posted on the cardholder's account. It can also be sent by an issuer to an acquirer or agent to advise that an authorisation has been successfully completed for the final amount and requests the clearing of the transaction."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="FinInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Sii_44ELEeu6D49Gi-ZPwQ"
previousVersion="_TwBNBlTQEeeeIYOiLZFQGg"
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="_Sii_5YELEeu6D49Gi-ZPwQ"
previousVersion="_TwBNCFTQEeeeIYOiLZFQGg"
name="Body"
definition="Information related to the financial initiation."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_fQ4TsYELEeu6D49Gi-ZPwQ" />
<messageBuildingBlock
xmi:id="_Sii_54ELEeu6D49Gi-ZPwQ"
previousVersion="_TwBNB1TQEeeeIYOiLZFQGg"
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="003"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.