ATMRejectV01

catp.005.001.01

The ATMReject message is sent by any entity to reject a received 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
%% ATMRejectV01 recursion level 0 with max 0
ATMRejectV01 *-- "1..1" Header22 : Header
ATMRejectV01 *-- "1..1" ATMReject1 : ATMReject
  

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

Header building block

Information related to the protocol management on a segment of the path from the ATM to the acquirer. Information related to the protocol management on a segment of the path from the ATM to the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header22 recursion level 0 with max 1
class Header22{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
    InitiatingParty IsoMax35Text
    RecipientParty IsoMax35Text
    ProcessState IsoMax35Text
}
Header22 *-- "1..1" ATMMessageFunction1 : MessageFunction
Header22 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction1 recursion level 1 with max 1
class ATMMessageFunction1{
    Function MessageFunction7Code
    ATMServiceCode IsoMax35Text
    HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
    SequenceNumber IsoMax35Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification
  

Header22 members

ATMReject building block

Information related to the reject of a message from an ATM or an ATM manager. Information related to the reject of a message from an ATM or an ATM manager. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMReject1 recursion level 0 with max 1
class ATMReject1{
    RejectInitiatorIdentification IsoMax35Text
    RejectReason RejectReason1Code
    AdditionalInformation IsoMax500Text
    MessageInError IsoMax100KBinary
}
ATMReject1 *-- "0..0" ATMCommand1 : Command
%% ATMCommand1 recursion level 1 with max 1
class ATMCommand1{
    Type ATMCommand1Code
    Urgency TMSContactLevel2Code
    DateTime IsoISODateTime
}
ATMCommand1 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
ATMCommand1 *-- "0..1" IATMCommandParameters1Choice : CommandParameters
  

ATMReject1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ATMRejectV01 --|> IOuterRecord : Implements
    ATMRejectV01Document --|> IOuterDocument~ATMRejectV01~ : Implements
    class IOuterDocument~ATMRejectV01~ {
        ATMRejectV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ATMRejectV01Document *-- ATMRejectV01 : 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:catp.005.001.01">
    <ATMRjct>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <ATMRjct>
            <!-- ATMReject inner content -->
        </ATMRjct>
    </ATMRjct>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DvwXcIrFEeSRwL6n4K9igA"
  nextVersions="_EnCvca42EeWpsoxRhdX-8A"
  name="ATMRejectV01"
  definition="The ATMReject message is sent by any entity to reject a received message."
  registrationStatus="Registered"
  messageSet="_lVeMdARsEeWTJNHF-ohSqw"
  xmlTag="ATMRjct"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_fyheoIrFEeSRwL6n4K9igA"
    name="Header"
    definition="Information related to the protocol management on a segment of the path from the ATM to the acquirer."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_VC-LsYrFEeSRwL6n4K9igA" />
  <messageBuildingBlock
    xmi:id="_3TnxcIrFEeSRwL6n4K9igA"
    name="ATMReject"
    definition="Information related to the reject of a message from an ATM or an ATM manager."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ATMRjct"
    complexType="_rjtNsIrFEeSRwL6n4K9igA" />
  <messageDefinitionIdentifier
    businessArea="catp"
    messageFunctionality="005"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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