catm.004.001.05
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 %% TerminalManagementRejectionV05 recursion level 0 with max 0 TerminalManagementRejectionV05 *-- "1..1" TMSHeader1 : Header TerminalManagementRejectionV05 *-- "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 transfer of transactions. For comparison, see the ISO20022 official specification
classDiagram direction tb %% TMSHeader1 recursion level 0 with max 1 class TMSHeader1{ DownloadTransfer IsoTrueFalseIndicator FormatVersion IsoMax6Text ExchangeIdentification IsoNumber CreationDateTime IsoISODateTime } TMSHeader1 *-- "1..1" GenericIdentification176 : InitiatingParty TMSHeader1 *-- "0..1" GenericIdentification177 : RecipientParty TMSHeader1 *-- "0..0" Traceability8 : Traceability %% GenericIdentification176 recursion level 1 with max 1 class GenericIdentification176{ Identification IsoMax35Text Type PartyType33Code Issuer PartyType33Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% GenericIdentification177 recursion level 1 with max 1 class GenericIdentification177{ Identification IsoMax35Text Type PartyType33Code Issuer PartyType33Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation %% Traceability8 recursion level 1 with max 1 class Traceability8{ ProtocolName IsoMax35Text ProtocolVersion IsoMax6Text TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification
TMSHeader1 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. | IsoNumber - Required 1..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. | GenericIdentification176 - Required 1..1 |
RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification177 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability8 - Unknown 0..0 |
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
Member name | Description | Data Type / Multiplicity |
---|---|---|
RejectReason | Reject reason of the request or the advice. | RejectReason2Code - 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. | IsoMax100KBinary - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the TerminalManagementRejectionV05 implementation follows a specific implementaiton pattern. First of all, TerminalManagementRejectionV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, TerminalManagementRejectionV05Document implements IOuterDocument. Because TerminalManagementRejectionV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type TerminalManagementRejectionV05.
classDiagram class IOuterRecord TerminalManagementRejectionV05 --|> IOuterRecord : Implements TerminalManagementRejectionV05Document --|> IOuterDocument~TerminalManagementRejectionV05~ : Implements class IOuterDocument~TerminalManagementRejectionV05~ { TerminalManagementRejectionV05 Message }
Document wrapper for serialization
The only real purpose TerminalManagementRejectionV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.004.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using TerminalManagementRejectionV05.ToDocument() method. The returned TerminalManagementRejectionV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram TerminalManagementRejectionV05Document *-- TerminalManagementRejectionV05 : 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.05">
<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="_LFU9MRBgEeqgJK7e3n_EXA"
previousVersion="_NHQLgY4BEeWrZqsymMFdfg"
name="TerminalManagementRejectionV05"
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="_WYMCwJVPEeO6Q83g-JIX_w"
xmlTag="TermnlMgmtRjctn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_LFYnkRBgEeqgJK7e3n_EXA"
type="purpose" />
<messageBuildingBlock
xmi:id="_LFYnkxBgEeqgJK7e3n_EXA"
previousVersion="_NHQLhY4BEeWrZqsymMFdfg"
name="Header"
definition="Rejection message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
<messageBuildingBlock
xmi:id="_LFYnlRBgEeqgJK7e3n_EXA"
previousVersion="_NHQLh44BEeWrZqsymMFdfg"
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="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.