ReconciliationResponseV03

caad.006.001.03

The ReconciliationResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a ReconciliationInitiation 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
%% ReconciliationResponseV03 recursion level 0 with max 0
ReconciliationResponseV03 *-- "1..1" Header60 : Header
ReconciliationResponseV03 *-- "1..1" ReconciliationResponse7 : Body
ReconciliationResponseV03 *-- "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.

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

Body building block

Information related to the reconciliation response. Information related to the reconciliation response message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReconciliationResponse7 recursion level 0 with max 1
ReconciliationResponse7 *-- "1..1" Environment33 : Environment
ReconciliationResponse7 *-- "0..1" Context17 : Context
ReconciliationResponse7 *-- "1..1" Transaction135 : Transaction
ReconciliationResponse7 *-- "1..1" ProcessingResult19 : ProcessingResult
ReconciliationResponse7 *-- "0..0" ProtectedData1 : ProtectedData
ReconciliationResponse7 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment33 recursion level 1 with max 1
Environment33 *-- "0..1" PartyIdentification263 : Originator
Environment33 *-- "0..1" PartyIdentification263 : Sender
Environment33 *-- "0..1" PartyIdentification263 : Receiver
Environment33 *-- "0..1" PartyIdentification263 : Destination
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction135 recursion level 1 with max 1
class Transaction135{
    ReconciliationFunction ReconciliationFunction1Code
    ReconciliationActivityType ReconciliationActivityType1Code
    OtherReconciliationActivityType IsoMax35Text
    ReconciliationType CardServiceType4Code
    OtherReconciliationType IsoMax35Text
    RequestedCurrency IsoExact3NumericText
}
Transaction135 *-- "0..1" TransactionIdentification12 : TransactionIdentification
Transaction135 *-- "0..0" TransactionTotals13 : ReconciliationTotals
Transaction135 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction135 *-- "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
%% 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
  

ReconciliationResponse7 members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the ReconciliationResponseV03 implementation follows a specific implementaiton pattern. First of all, ReconciliationResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReconciliationResponseV03Document implements IOuterDocument. Because ReconciliationResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReconciliationResponseV03.

classDiagram
    class IOuterRecord
    ReconciliationResponseV03 --|> IOuterRecord : Implements
    ReconciliationResponseV03Document --|> IOuterDocument~ReconciliationResponseV03~ : Implements
    class IOuterDocument~ReconciliationResponseV03~ {
        ReconciliationResponseV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ReconciliationResponseV03Document *-- ReconciliationResponseV03 : 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:caad.006.001.03">
    <RcncltnRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </RcncltnRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_CFmNIYv_EeuC5632vxUfGg"
  previousVersion="_7OfdhVUHEeetiruPyDPo0Q"
  name="ReconciliationResponseV03"
  definition="The ReconciliationResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a ReconciliationInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="RcncltnRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_CFmNI4v_EeuC5632vxUfGg"
    previousVersion="_7OfdhlUHEeetiruPyDPo0Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_x3IU4RvREey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_CFmNJYv_EeuC5632vxUfGg"
    previousVersion="_7Ofdh1UHEeetiruPyDPo0Q"
    name="Body"
    definition="Information related to the reconciliation response."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_Y5jikYv-EeuC5632vxUfGg" />
  <messageBuildingBlock
    xmi:id="_CFmNJ4v_EeuC5632vxUfGg"
    previousVersion="_7OfdiFUHEeetiruPyDPo0Q"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="caad"
    messageFunctionality="006"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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