TerminalManagementRejectionV03

catm.004.001.03

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
%% TerminalManagementRejectionV03 recursion level 0 with max 0
TerminalManagementRejectionV03 *-- "1..1" Header15 : Header
TerminalManagementRejectionV03 *-- "1..1" AcceptorRejection3 : 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
%% Header15 recursion level 0 with max 1
class Header15{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header15 *-- "0..1" GenericIdentification71 : InitiatingParty
Header15 *-- "0..1" GenericIdentification71 : RecipientParty
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
  

Header15 members

Reject building block

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

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

AcceptorRejection3 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TerminalManagementRejectionV03 --|> IOuterRecord : Implements
    TerminalManagementRejectionV03Document --|> IOuterDocument~TerminalManagementRejectionV03~ : Implements
    class IOuterDocument~TerminalManagementRejectionV03~ {
        TerminalManagementRejectionV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    TerminalManagementRejectionV03Document *-- TerminalManagementRejectionV03 : 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.03">
    <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="_5h17wWp0EeSMqvBfBY1c9A"
  nextVersions="_NHQLgY4BEeWrZqsymMFdfg"
  previousVersion="_DWVHgTZ9EeOP_KvUKe29ng"
  name="TerminalManagementRejectionV03"
  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="_5h17w2p0EeSMqvBfBY1c9A"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_5h17xWp0EeSMqvBfBY1c9A"
    nextVersions="_NHQLhY4BEeWrZqsymMFdfg"
    previousVersion="_DWVHgzZ9EeOP_KvUKe29ng"
    name="Header"
    definition="Rejection message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_8BbjoWp0EeSMqvBfBY1c9A" />
  <messageBuildingBlock
    xmi:id="_5h17x2p0EeSMqvBfBY1c9A"
    nextVersions="_NHQLh44BEeWrZqsymMFdfg"
    previousVersion="_DWVHhTZ9EeOP_KvUKe29ng"
    name="Reject"
    definition="Information related to the reject."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Rjct"
    complexType="_G5i8sWp1EeSMqvBfBY1c9A" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="004"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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