TerminalManagementRejectionV02

catm.004.001.02

The TerminalManagementRejection message is sent by the terminal manager to reject a message request sent by an acceptor, to indicate that the received message could not be processed.

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
%% TerminalManagementRejectionV02 recursion level 0 with max 0
TerminalManagementRejectionV02 *-- "1..1" Header6 : Header
TerminalManagementRejectionV02 *-- "1..1" AcceptorRejection2 : Reject
  

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Rejection message management information. Set of characteristics related to the reject of a transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header6 recursion level 0 with max 1
class Header6{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header6 *-- "0..1" GenericIdentification35 : InitiatingParty
Header6 *-- "0..1" GenericIdentification35 : RecipientParty
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
  

Header6 members

Reject building block

Information related to the reject. Reject of an exchange. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorRejection2 recursion level 0 with max 1
class AcceptorRejection2{
    RejectReason RejectReason1Code
    AdditionalInformation IsoMax500Text
    MessageInError IsoMax100KBinary
}
  

AcceptorRejection2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TerminalManagementRejectionV02 --|> IOuterRecord : Implements
    TerminalManagementRejectionV02Document --|> IOuterDocument~TerminalManagementRejectionV02~ : Implements
    class IOuterDocument~TerminalManagementRejectionV02~ {
        TerminalManagementRejectionV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    TerminalManagementRejectionV02Document *-- TerminalManagementRejectionV02 : 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:catm.004.001.02">
    <TermnlMgmtRjctn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Rjct>
            <!-- Reject inner content -->
        </Rjct>
    </TermnlMgmtRjctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DWVHgTZ9EeOP_KvUKe29ng"
  nextVersions="_5h17wWp0EeSMqvBfBY1c9A"
  previousVersion="_k-lJ8CnCEeKIjpr--01h3Q"
  name="TerminalManagementRejectionV02"
  definition="The TerminalManagementRejection message is sent by the terminal manager to reject a message request sent by an acceptor, to indicate that the received message could not be processed."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="TermnlMgmtRjctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_DhBUkDZ9EeOP_KvUKe29ng"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_DWVHgzZ9EeOP_KvUKe29ng"
    nextVersions="_5h17xWp0EeSMqvBfBY1c9A"
    previousVersion="_ixo70CnDEeKIjpr--01h3Q"
    name="Header"
    definition="Rejection message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_AniC8SnDEeKIjpr--01h3Q" />
  <messageBuildingBlock
    xmi:id="_DWVHhTZ9EeOP_KvUKe29ng"
    nextVersions="_5h17x2p0EeSMqvBfBY1c9A"
    previousVersion="_NrrOsCnDEeKIjpr--01h3Q"
    name="Reject"
    definition="Information related to the reject."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Rjct"
    complexType="_8TjN8TTfEeO5e9wx3yvd8g" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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