FraudReportingResponseV02

cafr.002.001.02

A FraudReportingResponse message is sent by an agent (processor, agent) to an issuer or acquirer in response to a FraudReportingInitiation 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
%% FraudReportingResponseV02 recursion level 0 with max 0
FraudReportingResponseV02 *-- "1..1" Header66 : Header
FraudReportingResponseV02 *-- "1..1" FraudReportingResponse2 : Body
FraudReportingResponseV02 *-- "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. 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

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. 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 initiation of the fraud reporting. Information related to the fraud reporting response message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% FraudReportingResponse2 recursion level 0 with max 1
FraudReportingResponse2 *-- "1..1" Environment28 : Environment
FraudReportingResponse2 *-- "0..1" Context17 : Context
FraudReportingResponse2 *-- "1..1" Transaction129 : Transaction
FraudReportingResponse2 *-- "1..1" ProcessingResult19 : ProcessingResult
FraudReportingResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment28 recursion level 1 with max 1
Environment28 *-- "0..1" PartyIdentification263 : Acquirer
Environment28 *-- "0..1" PartyIdentification263 : Originator
Environment28 *-- "0..1" PartyIdentification263 : Sender
Environment28 *-- "0..1" PartyIdentification263 : Receiver
Environment28 *-- "0..1" PartyIdentification263 : Destination
Environment28 *-- "0..1" PartyIdentification263 : Issuer
Environment28 *-- "0..1" CardData8 : Card
Environment28 *-- "0..1" Token2 : Token
Environment28 *-- "0..1" Cardholder19 : Cardholder
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction129 recursion level 1 with max 1
class Transaction129{
    FraudTransactionIdentification IsoMax70Text
}
Transaction129 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction129 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult19 recursion level 1 with max 1
ProcessingResult19 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult19 *-- "1..1" ResultData10 : ResultData
ProcessingResult19 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult19 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult19 *-- "0..0" AdditionalInformation30 : AdditionalInformation
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

FraudReportingResponse2 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. Environment28 - Required 1..1
Context Contains or describes conditions and characteristics of the transaction. Context17 - Optional 0..1
Transaction Transaction details of fraud reporting response. Transaction129 - Required 1..1
ProcessingResult Outcome of processing of the fraud reporting. ProcessingResult19 - 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. 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 FraudReportingResponseV02 implementation follows a specific implementaiton pattern. First of all, FraudReportingResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FraudReportingResponseV02Document implements IOuterDocument. Because FraudReportingResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FraudReportingResponseV02.

classDiagram
    class IOuterRecord
    FraudReportingResponseV02 --|> IOuterRecord : Implements
    FraudReportingResponseV02Document --|> IOuterDocument~FraudReportingResponseV02~ : Implements
    class IOuterDocument~FraudReportingResponseV02~ {
        FraudReportingResponseV02 Message
     }
  

Document wrapper for serialization

The only real purpose FraudReportingResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:cafr.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 FraudReportingResponseV02.ToDocument() method. The returned FraudReportingResponseV02Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    FraudReportingResponseV02Document *-- FraudReportingResponseV02 : 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:cafr.002.001.02">
    <FrdRptgRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </FrdRptgRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Rt_mJMr8EeuNe7RtB4qFHw"
  name="FraudReportingResponseV02"
  definition="A FraudReportingResponse message is sent by an agent (processor, agent) to an issuer or acquirer in response to a FraudReportingInitiation message.&#xD;"
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="FrdRptgRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Rt_mJ8r8EeuNe7RtB4qFHw"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_aRA58RynEeyVgKPonV4SjQ" />
  <messageBuildingBlock
    xmi:id="_Rt_mJsr8EeuNe7RtB4qFHw"
    name="Body"
    definition="Information related to the initiation of the fraud reporting."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_U-EzMYv4EeumSPwlS1PkxQ" />
  <messageBuildingBlock
    xmi:id="_Rt_mJcr8EeuNe7RtB4qFHw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="cafr"
    messageFunctionality="002"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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