Iso20022

AcquirerFinancialResponse

cain.004.001.01

The AcquirerFinancialResponse message is sent by an issuer or an agent to answer to an AcquirerFinancialInitiation 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
%% AcquirerFinancialResponse recursion level 0 with max 0
AcquirerFinancialResponse *-- "1..1" Header17 : Header
AcquirerFinancialResponse *-- "1..1" AcquirerFinancialResponse1 : FinancialResponse
AcquirerFinancialResponse *-- "0..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

FinancialResponse building block

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

classDiagram
   direction tb
%% AcquirerFinancialResponse1 recursion level 0 with max 1
AcquirerFinancialResponse1 *-- "1..1" CardTransactionEnvironment2 : Environment
AcquirerFinancialResponse1 *-- "0..1" CardTransactionContext3 : Context
AcquirerFinancialResponse1 *-- "1..1" CardTransaction6 : Transaction
%% CardTransactionEnvironment2 recursion level 1 with max 1
class CardTransactionEnvironment2{
    AcquirerIdentification IsoMax35Text
    CardSchemeIdentification IsoMax35Text
    AcceptorIdentification IsoMax35Text
    TerminalIdentification IsoMax35Text
}
CardTransactionEnvironment2 *-- "1..1" PaymentCard13 : Card
CardTransactionEnvironment2 *-- "0..1" CardPaymentToken2 : PaymentToken
CardTransactionEnvironment2 *-- "0..1" PostalAddress18 : ShippingAddress
%% CardTransactionContext3 recursion level 1 with max 1
CardTransactionContext3 *-- "1..1" CardTransactionContext4 : TransactionContext
%% CardTransaction6 recursion level 1 with max 1
class CardTransaction6{
    TransactionType CardPaymentServiceType7Code
    AcceptorTransactionDateTime IsoISODateTime
    InitiatorTransactionIdentification IsoMax35Text
    TransactionLifeCycleIdentification IsoMax35Text
    TransactionLifeCycleSequenceNumber IsoNumber
    TransactionLifeCycleSequenceCounter IsoNumber
    CardIssuerReferenceData IsoMax140Text
}
CardTransaction6 *-- "0..1" TransactionIdentifier2 : Reconciliation
CardTransaction6 *-- "1..1" CardTransactionDetail4 : TransactionDetails
CardTransaction6 *-- "0..1" AuthorisationResult8 : AuthorisationResult

AcquirerFinancialResponse1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardTransactionEnvironment2 - Required 1..1
Context Context in which the card transaction is performed. CardTransactionContext3 - Optional 0..1
Transaction Card transaction for which the financial authorisation has been requested. CardTransaction6 - 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 AcquirerFinancialResponse implementation follows a specific implementaiton pattern. First of all, AcquirerFinancialResponse impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcquirerFinancialResponseDocument implements IOuterDocument. Because AcquirerFinancialResponse implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcquirerFinancialResponse.

classDiagram
    class IOuterRecord
    AcquirerFinancialResponse --|> IOuterRecord : Implements
    AcquirerFinancialResponseDocument --|> IOuterDocument~AcquirerFinancialResponse~ : Implements
    class IOuterDocument~AcquirerFinancialResponse~ {
        AcquirerFinancialResponse Message
     }

Document wrapper for serialization

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

classDiagram
    AcquirerFinancialResponseDocument *-- AcquirerFinancialResponse : 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.004.001.01">
    <AcqrrFinRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <FinRspn>
            <!-- FinancialResponse inner content -->
        </FinRspn>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AcqrrFinRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_K53kQHucEeSBS-QFUaKA-g"
  nextVersions="_aga5FVTsEeeeIYOiLZFQGg"
  name="AcquirerFinancialResponse"
  definition="The AcquirerFinancialResponse message is sent by an issuer or an agent to answer to an AcquirerFinancialInitiation message."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AcqrrFinRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_V0OZAHucEeSBS-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="_oMbT0HumEeSBS-QFUaKA-g"
    name="FinancialResponse"
    definition="Information related to the response of a financial authorisation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="FinRspn"
    complexType="_eBZDMHumEeSBS-QFUaKA-g" />
  <messageBuildingBlock
    xmi:id="_7ieigHumEeSBS-QFUaKA-g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
  <messageDefinitionIdentifier
    businessArea="cain"
    messageFunctionality="004"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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