cafm.002.001.02
A FileActionResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a FileActionInitiation 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
%% FileActionResponseV02 recursion level 0 with max 0
FileActionResponseV02 *-- "1..1" Header60 : Header
FileActionResponseV02 *-- "1..1" FileActionResponse2 : Body
FileActionResponseV02 *-- "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. Set of characteristics related to the protocol.
For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header60 recursion level 0 with max 1
class Header60{
MessageFunction MessageFunction17Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header60 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header60 *-- "1..1" GenericIdentification183 : InitiatingParty
Header60 *-- "0..1" GenericIdentification183 : RecipientParty
Header60 *-- "0..0" AdditionalData1 : TraceData
Header60 *-- "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
Header60 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction17Code - 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 response to of a file action. Information related to the file action. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% FileActionResponse2 recursion level 0 with max 1
FileActionResponse2 *-- "1..1" Environment22 : Environment
FileActionResponse2 *-- "0..1" Context17 : Context
FileActionResponse2 *-- "1..1" Transaction158 : Transaction
FileActionResponse2 *-- "1..1" ResultData9 : ProcessingResult
FileActionResponse2 *-- "0..0" ProtectedData1 : ProtectedData
FileActionResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment22 recursion level 1 with max 1
Environment22 *-- "0..1" PartyIdentification263 : Acquirer
Environment22 *-- "0..1" PartyIdentification263 : Originator
Environment22 *-- "0..1" PartyIdentification263 : Sender
Environment22 *-- "0..1" PartyIdentification263 : Receiver
Environment22 *-- "0..1" PartyIdentification254 : Acceptor
Environment22 *-- "0..1" PartyIdentification257 : Payer
Environment22 *-- "0..1" PartyIdentification257 : Payee
Environment22 *-- "0..1" Terminal4 : Terminal
Environment22 *-- "0..1" PartyIdentification263 : Issuer
Environment22 *-- "0..1" CardData8 : Card
Environment22 *-- "0..1" PartyIdentification263 : Destination
Environment22 *-- "0..1" CustomerDevice4 : CustomerDevice
Environment22 *-- "0..1" Wallet2 : Wallet
Environment22 *-- "0..1" Token3 : Token
Environment22 *-- "0..1" Cardholder19 : Cardholder
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction158 recursion level 1 with max 1
Transaction158 *-- "0..1" TransactionIdentification12 : TransactionIdentification
Transaction158 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction158 *-- "0..0" AdditionalData1 : AdditionalData
Transaction158 *-- "1..1" FileActionDetails2 : FileActionDetails
%% ResultData9 recursion level 1 with max 1
class ResultData9{
Result FileActionResult1Code
OtherResult IsoMax35Text
ResultDetails ISO8583ResponseCode
OtherResultDetails IsoMax35Text
}
%% 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
FileActionResponse2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the file action transaction. | Environment22 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context17 - Optional 0..1 |
| Transaction | File action transaction details. | Transaction158 - Required 1..1 |
| ProcessingResult | Results of the file action processing. | ResultData9 - Required 1..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. 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 FileActionResponseV02 implementation follows a specific implementaiton pattern. First of all, FileActionResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FileActionResponseV02Document implements IOuterDocument. Because FileActionResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FileActionResponseV02.
classDiagram
class IOuterRecord
FileActionResponseV02 --|> IOuterRecord : Implements
FileActionResponseV02Document --|> IOuterDocument~FileActionResponseV02~ : Implements
class IOuterDocument~FileActionResponseV02~ {
FileActionResponseV02 Message
}
Document wrapper for serialization
The only real purpose FileActionResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cafm.002.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FileActionResponseV02.ToDocument() method. The returned FileActionResponseV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FileActionResponseV02Document *-- FileActionResponseV02 : 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:cafm.002.001.02">
<FileActnRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</FileActnRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_1ejJcYKwEeu4svNQ5N-l6w"
previousVersion="_LzUbFFZjEeen1vB4iz5SyA"
name="FileActionResponseV02"
definition="A FileActionResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a FileActionInitiation message."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="FileActnRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_1ejJc4KwEeu4svNQ5N-l6w"
previousVersion="_LzUbFlZjEeen1vB4iz5SyA"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_x3IU4RvREey2RdTw-AkXzg" />
<messageBuildingBlock
xmi:id="_1ejJdYKwEeu4svNQ5N-l6w"
previousVersion="_LzUbFVZjEeen1vB4iz5SyA"
name="Body"
definition="Information related to the response to of a file action."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_gZVqQYKwEeu4svNQ5N-l6w" />
<messageBuildingBlock
xmi:id="_1ejJd4KwEeu4svNQ5N-l6w"
previousVersion="_LzUbF1ZjEeen1vB4iz5SyA"
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="cafm"
messageFunctionality="002"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.