FeeCollectionInitiationV02

cafc.001.001.02

The FeeCollectionInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) to claim or pay a miscellaneous service between financial institutions. Fee collection messages have financial impacts and affect reconciliation totals without affecting a cardholder account.

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
%% FeeCollectionInitiationV02 recursion level 0 with max 0
FeeCollectionInitiationV02 *-- "1..1" Header66 : Header
FeeCollectionInitiationV02 *-- "1..1" FeeCollectionInitiation2 : Body
FeeCollectionInitiationV02 *-- "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 protocol management. ISO 8583 MTI 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 initiation of a fee collection. Information related to a fee collection initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% FeeCollectionInitiation2 recursion level 0 with max 1
FeeCollectionInitiation2 *-- "1..1" Environment23 : Environment
FeeCollectionInitiation2 *-- "0..1" Context16 : Context
FeeCollectionInitiation2 *-- "1..1" Transaction156 : Transaction
FeeCollectionInitiation2 *-- "0..1" ProcessingResult14 : ProcessingResult
FeeCollectionInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
FeeCollectionInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment23 recursion level 1 with max 1
Environment23 *-- "0..1" PartyIdentification263 : Acquirer
Environment23 *-- "0..1" PartyIdentification263 : Originator
Environment23 *-- "0..1" PartyIdentification263 : Sender
Environment23 *-- "0..1" PartyIdentification263 : Receiver
Environment23 *-- "0..1" PartyIdentification255 : Acceptor
Environment23 *-- "0..1" PartyIdentification263 : Destination
Environment23 *-- "0..1" PartyIdentification263 : Issuer
Environment23 *-- "0..1" CardData2 : Card
Environment23 *-- "0..1" Token2 : Token
%% Context16 recursion level 1 with max 1
Context16 *-- "0..1" TransactionContext8 : TransactionContext
%% Transaction156 recursion level 1 with max 1
class Transaction156{
    TransactionType ISO8583TransactionTypeCode
    TransactionSubType IsoMax35Text
    CancellationIndicator IsoTrueFalseIndicator
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    FeeCollectionCycle IsoExact1NumericText
}
Transaction156 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction156 *-- "1..1" TransactionIdentification51 : TransactionIdentification
Transaction156 *-- "1..1" TransactionAmounts2 : TransactionAmounts
Transaction156 *-- "0..0" AdditionalAmounts3 : AdditionalAmount
Transaction156 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction156 *-- "0..0" AdditionalData1 : AdditionalData
Transaction156 *-- "0..1" FeeCollectionReference1 : FeeCollectionReference
%% ProcessingResult14 recursion level 1 with max 1
ProcessingResult14 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult14 *-- "0..1" ResultData10 : ResultData
ProcessingResult14 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult14 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult14 *-- "0..0" AdditionalInformation30 : 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
  

FeeCollectionInitiation2 members

SecurityTrailer building block

Trailer of the message containing a MAC. It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128. 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 FeeCollectionInitiationV02 implementation follows a specific implementaiton pattern. First of all, FeeCollectionInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FeeCollectionInitiationV02Document implements IOuterDocument. Because FeeCollectionInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FeeCollectionInitiationV02.

classDiagram
    class IOuterRecord
    FeeCollectionInitiationV02 --|> IOuterRecord : Implements
    FeeCollectionInitiationV02Document --|> IOuterDocument~FeeCollectionInitiationV02~ : Implements
    class IOuterDocument~FeeCollectionInitiationV02~ {
        FeeCollectionInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    FeeCollectionInitiationV02Document *-- FeeCollectionInitiationV02 : 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:cafc.001.001.02">
    <FeeColltnInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </FeeColltnInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_3auewYaAEeuSbct6WWD-Ng"
  previousVersion="_q5bNFFaHEeeFltjJxERUxw"
  name="FeeCollectionInitiationV02"
  definition="The FeeCollectionInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) to claim or pay a miscellaneous service between financial institutions. Fee collection messages have financial impacts and affect reconciliation totals without affecting a cardholder account.&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="FeeColltnInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_3avF0YaAEeuSbct6WWD-Ng"
    previousVersion="_q5bNFlaHEeeFltjJxERUxw"
    name="Header"
    definition="Information related to the protocol management.&#xD;&#xA;ISO 8583 MTI"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_aRA58RynEeyVgKPonV4SjQ" />
  <messageBuildingBlock
    xmi:id="_3avF04aAEeuSbct6WWD-Ng"
    previousVersion="_q5bNFVaHEeeFltjJxERUxw"
    name="Body"
    definition="Information related to the initiation of a fee collection."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_EXWGMYaBEeuSbct6WWD-Ng" />
  <messageBuildingBlock
    xmi:id="_3avF1YaAEeuSbct6WWD-Ng"
    previousVersion="_q5bNF1aHEeeFltjJxERUxw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC.&#xD;&#xA;It corresponds partially to ISO 8583 field number 53, completed by the field number 64 or 128."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="cafc"
    messageFunctionality="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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