cafc.002.001.01
The FeeCollectionResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a FeeCollectionInitiation 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
%% FeeCollectionResponseV01 recursion level 0 with max 0
FeeCollectionResponseV01 *-- "1..1" Header48 : Header
FeeCollectionResponseV01 *-- "1..1" FeeCollectionResponse1 : Body
FeeCollectionResponseV01 *-- "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
%% Header48 recursion level 0 with max 1
class Header48{
MessageFunction MessageFunction29Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header48 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header48 *-- "1..1" GenericIdentification172 : InitiatingParty
Header48 *-- "0..1" GenericIdentification172 : RecipientParty
Header48 *-- "0..0" AdditionalData1 : TraceData
Header48 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
CollectionIdentification IsoMax35Text
BatchIdentification IsoMax35Text
MessageSequenceNumber IsoMax15NumericText
MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
Type IsoMax35Text
Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
Header48 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction29Code - 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. | GenericIdentification172 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification172 - 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. ISO 8583:93/2003 bit 59 | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability7 - Unknown 0..0 |
Body building block
Information related to the response of a fee collection initiation message.. Information related to a fee collection response message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% FeeCollectionResponse1 recursion level 0 with max 1
FeeCollectionResponse1 *-- "1..1" Environment5 : Environment
FeeCollectionResponse1 *-- "0..1" Context9 : Context
FeeCollectionResponse1 *-- "1..1" Transaction103 : Transaction
FeeCollectionResponse1 *-- "1..1" ProcessingResult4 : ProcessingResult
FeeCollectionResponse1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment5 recursion level 1 with max 1
Environment5 *-- "0..1" PartyIdentification197 : Acquirer
Environment5 *-- "0..1" PartyIdentification197 : Originator
Environment5 *-- "0..1" PartyIdentification197 : Sender
Environment5 *-- "0..1" PartyIdentification197 : Receiver
Environment5 *-- "0..1" PartyIdentification203 : Acceptor
Environment5 *-- "0..1" PartyIdentification197 : Destination
Environment5 *-- "0..1" CardData2 : Card
Environment5 *-- "0..1" Token1 : Token
%% Context9 recursion level 1 with max 1
Context9 *-- "0..1" TransactionContext3 : TransactionContext
%% Transaction103 recursion level 1 with max 1
class Transaction103{
TransactionType IsoExact2AlphaNumericText
TransactionSubType IsoMax35Text
MessageReason IsoExact4NumericText
AlternateMessageReason IsoMax35Text
}
Transaction103 *-- "0..0" SpecialProgrammeQualification1 : SpecialProgrammeQualification
Transaction103 *-- "1..1" TransactionIdentification13 : TransactionIdentification
Transaction103 *-- "1..1" TransactionAmounts1 : TransactionAmounts
Transaction103 *-- "0..0" AdditionalAmounts1 : AdditionalAmounts
Transaction103 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction103 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult4 recursion level 1 with max 1
ProcessingResult4 *-- "0..1" ResultData5 : ResultData
ProcessingResult4 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult4 *-- "0..0" AdditionalInformation22 : AdditionalInformation
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
FeeCollectionResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction | Environment5 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context9 - Optional 0..1 |
| Transaction | Card transaction for which an authorisation is requested. | Transaction103 - Required 1..1 |
| ProcessingResult | Outcome of the processing of the authorisation | ProcessingResult4 - Required 1..1 |
| 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. 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
| 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 FeeCollectionResponseV01 implementation follows a specific implementaiton pattern. First of all, FeeCollectionResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FeeCollectionResponseV01Document implements IOuterDocument. Because FeeCollectionResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FeeCollectionResponseV01.
classDiagram
class IOuterRecord
FeeCollectionResponseV01 --|> IOuterRecord : Implements
FeeCollectionResponseV01Document --|> IOuterDocument~FeeCollectionResponseV01~ : Implements
class IOuterDocument~FeeCollectionResponseV01~ {
FeeCollectionResponseV01 Message
}
Document wrapper for serialization
The only real purpose FeeCollectionResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cafc.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FeeCollectionResponseV01.ToDocument() method. The returned FeeCollectionResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FeeCollectionResponseV01Document *-- FeeCollectionResponseV01 : 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.002.001.01">
<FeeColltnRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</FeeColltnRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_WzFGdFciEeeFltjJxERUxw"
nextVersions="_6oy9QYaAEeuSbct6WWD-Ng"
name="FeeCollectionResponseV01"
definition="The FeeCollectionResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a FeeCollectionInitiation message."
registrationStatus="Registered"
messageSet="_oFVkcKmaEeqA4rV5xCgycA"
xmlTag="FeeColltnRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_WzFGd1ciEeeFltjJxERUxw"
nextVersions="_6oy9Q4aAEeuSbct6WWD-Ng"
name="Header"
definition="Information related to the protocol management.
ISO 8583 MTI"
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_wmyN8VaGEeeFltjJxERUxw" />
<messageBuildingBlock
xmi:id="_WzFGdlciEeeFltjJxERUxw"
nextVersions="_6oy9RYaAEeuSbct6WWD-Ng"
name="Body"
definition="Information related to the response of a fee collection initiation message.."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_6pSKMVchEeeFltjJxERUxw" />
<messageBuildingBlock
xmi:id="_WzFGdVciEeeFltjJxERUxw"
nextVersions="_6oy9R4aAEeuSbct6WWD-Ng"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC.
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="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.