catm.004.001.01
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 %% TerminalManagementRejectionV01 recursion level 0 with max 0 TerminalManagementRejectionV01 *-- "1..1" Header6 : Header TerminalManagementRejectionV01 *-- "1..1" AcceptorRejection1 : 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
Member name | Description | Data Type / Multiplicity |
---|---|---|
DownloadTransfer | Indicates if the file transfer is a download or an upload. | IsoTrueFalseIndicator - Required 1..1 |
FormatVersion | Version of file format. | IsoMax6Text - Required 1..1 |
ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Optional 0..1 |
CreationDateTime | Date and time at which the file or message was created. | IsoISODateTime - Required 1..1 |
InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification35 - Optional 0..1 |
RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification35 - Optional 0..1 |
Reject building block
Information related to the reject. Reject of an exchange. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorRejection1 recursion level 0 with max 1 class AcceptorRejection1{ RejectReason RejectReason1Code AdditionalInformation IsoMax500Text MessageInError IsoMax5000Binary }
AcceptorRejection1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
RejectReason | Reject reason of the request or the advice. | RejectReason1Code - Required 1..1 |
AdditionalInformation | Additional information related to the reject of the exchange. | IsoMax500Text - Optional 0..1 |
MessageInError | Original request that caused the recipient party to reject it. | IsoMax5000Binary - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the TerminalManagementRejectionV01 implementation follows a specific implementaiton pattern. First of all, TerminalManagementRejectionV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, TerminalManagementRejectionV01Document implements IOuterDocument. Because TerminalManagementRejectionV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type TerminalManagementRejectionV01.
classDiagram class IOuterRecord TerminalManagementRejectionV01 --|> IOuterRecord : Implements TerminalManagementRejectionV01Document --|> IOuterDocument~TerminalManagementRejectionV01~ : Implements class IOuterDocument~TerminalManagementRejectionV01~ { TerminalManagementRejectionV01 Message }
Document wrapper for serialization
The only real purpose TerminalManagementRejectionV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.004.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using TerminalManagementRejectionV01.ToDocument() method. The returned TerminalManagementRejectionV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram TerminalManagementRejectionV01Document *-- TerminalManagementRejectionV01 : 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.01">
<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="_k-lJ8CnCEeKIjpr--01h3Q"
nextVersions="_DWVHgTZ9EeOP_KvUKe29ng"
name="TerminalManagementRejectionV01"
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">
<messageBuildingBlock
xmi:id="_ixo70CnDEeKIjpr--01h3Q"
nextVersions="_DWVHgzZ9EeOP_KvUKe29ng"
name="Header"
definition="Rejection message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_AniC8SnDEeKIjpr--01h3Q" />
<messageBuildingBlock
xmi:id="_NrrOsCnDEeKIjpr--01h3Q"
nextVersions="_DWVHhTZ9EeOP_KvUKe29ng"
name="Reject"
definition="Information related to the reject."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Rjct"
complexType="_Svfw9wEcEeCQm6a_G2yO_w_1794621080" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="004"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.