ATMDepositRequestV01

catp.012.001.01

The ATMDepositRequest message is sent by an ATM to an acquirer or its agent to request the approval of a deposit transaction at an ATM, before or after deposit media inside the ATM.

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
%% ATMDepositRequestV01 recursion level 0 with max 0
ATMDepositRequestV01 *-- "1..1" Header31 : Header
ATMDepositRequestV01 *-- "0..1" ContentInformationType10 : ProtectedATMDepositRequest
ATMDepositRequestV01 *-- "0..1" ATMDepositRequest1 : ATMDepositRequest
ATMDepositRequestV01 *-- "0..1" ContentInformationType15 : SecurityTrailer

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
%% Header31 recursion level 0 with max 1
class Header31{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
    InitiatingParty IsoMax35Text
    RecipientParty IsoMax35Text
    ProcessState IsoMax35Text
}
Header31 *-- "1..1" ATMMessageFunction2 : MessageFunction
Header31 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction2 recursion level 1 with max 1
class ATMMessageFunction2{
    Function MessageFunction11Code
    ATMServiceCode IsoMax35Text
    HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
    SequenceNumber IsoMax35Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification

Header31 members

Member name	Description	Data Type / Multiplicity
MessageFunction	Identifies the type of process related to the message.	ATMMessageFunction2 - Required 1..1
ProtocolVersion	Version of the ATM protocol specifications.	IsoMax6Text - Required 1..1
ExchangeIdentification	Unique identification of an exchange occurrence.	IsoMax3NumericText - Required 1..1
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Required 1..1
InitiatingParty	Unique identification of the partner that has initiated the exchange.	IsoMax35Text - Required 1..1
RecipientParty	Unique identification of the partner that is the recipient of the message exchange.	IsoMax35Text - Optional 0..1
ProcessState	State of the sender of the message inside the process flow.	IsoMax35Text - Optional 0..1
Traceability	Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges.	Traceability4 - Unknown 0..0

ProtectedATMDepositRequest building block

Encrypted body of the message. General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType10 recursion level 0 with max 1
class ContentInformationType10{
    ContentType ContentType2Code
}
ContentInformationType10 *-- "1..1" EnvelopedData4 : EnvelopedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
    Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent

ContentInformationType10 members

Member name	Description	Data Type / Multiplicity
ContentType	Type of data protection.	ContentType2Code - Required 1..1
EnvelopedData	Data protection by encryption or by a digital envelope, with an encryption key.	EnvelopedData4 - Required 1..1

ATMDepositRequest building block

Information related to the request of a deposit transaction from an ATM. Information related to the request of a deposit transaction from an ATM. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMDepositRequest1 recursion level 0 with max 1
ATMDepositRequest1 *-- "1..1" ATMEnvironment11 : Environment
ATMDepositRequest1 *-- "1..1" ATMContext10 : Context
ATMDepositRequest1 *-- "1..1" ATMTransaction15 : Transaction
%% ATMEnvironment11 recursion level 1 with max 1
class ATMEnvironment11{
    ATMManagerIdentification IsoMax35Text
}
ATMEnvironment11 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment11 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment11 *-- "1..1" AutomatedTellerMachine9 : ATM
ATMEnvironment11 *-- "1..1" ATMCustomer4 : Customer
ATMEnvironment11 *-- "0..1" PaymentCard22 : Card
%% ATMContext10 recursion level 1 with max 1
class ATMContext10{
    SessionReference IsoMax35Text
}
ATMContext10 *-- "0..1" ATMService11 : Service
%% ATMTransaction15 recursion level 1 with max 1
class ATMTransaction15{
    ReconciliationIdentification IsoMax35Text
    RequestedReceipt IsoTrueFalseIndicator
    ICCRelatedData IsoMax10000Binary
}
ATMTransaction15 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
ATMTransaction15 *-- "0..1" CardAccount9 : AccountData
ATMTransaction15 *-- "0..1" ContentInformationType10 : ProtectedAccountData
ATMTransaction15 *-- "0..1" AmountAndCurrency1 : TotalAmount
ATMTransaction15 *-- "0..0" DetailedAmount16 : DetailedRequestedAmount
ATMTransaction15 *-- "0..0" ATMDepositedMedia1 : DepositedMedia

ATMDepositRequest1 members

Member name	Description	Data Type / Multiplicity
Environment	Environment in which the transaction is performed.	ATMEnvironment11 - Required 1..1
Context	Context in which the deposit transaction is performed.	ATMContext10 - Required 1..1
Transaction	Deposit transaction for which the service is requested.	ATMTransaction15 - Required 1..1

SecurityTrailer building block

Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
    ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType15 members

Member name	Description	Data Type / Multiplicity
ContentType	Type of data protection.	ContentType2Code - Required 1..1
AuthenticatedData	Data protection by a message authentication code (MAC).	AuthenticatedData4 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ATMDepositRequestV01 --|> IOuterRecord : Implements
    ATMDepositRequestV01Document --|> IOuterDocument~ATMDepositRequestV01~ : Implements
    class IOuterDocument~ATMDepositRequestV01~ {
        ATMDepositRequestV01 Message
     }

Document wrapper for serialization

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

classDiagram
    ATMDepositRequestV01Document *-- ATMDepositRequestV01 : 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.012.001.01">
    <ATMDpstReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMDpstReq>
            <!-- ProtectedATMDepositRequest inner content -->
        </PrtctdATMDpstReq>
        <ATMDpstReq>
            <!-- ATMDepositRequest inner content -->
        </ATMDpstReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMDpstReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_VweFcK39EeWL1uap3dNhCQ"
  name="ATMDepositRequestV01"
  definition="The ATMDepositRequest message is sent by an ATM to an acquirer or its agent to request the approval of a deposit transaction at an ATM, before or after deposit media inside the ATM."
  registrationStatus="Registered"
  messageSet="_wx2hAK1hEeWMg5rOByfExw"
  xmlTag="ATMDpstReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_g4CPwK39EeWL1uap3dNhCQ"
    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="_eMl4Qa1wEeWMg5rOByfExw" />
  <messageBuildingBlock
    xmi:id="_o-6QQK39EeWL1uap3dNhCQ"
    name="ProtectedATMDepositRequest"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMDpstReq"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_sJ93AK39EeWL1uap3dNhCQ"
    name="ATMDepositRequest"
    definition="Information related to the request of a deposit transaction from an ATM."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMDpstReq"
    complexType="_6lj94K39EeWL1uap3dNhCQ" />
  <messageBuildingBlock
    xmi:id="_zLRWkK39EeWL1uap3dNhCQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
  <messageDefinitionIdentifier
    businessArea="catp"
    messageFunctionality="012"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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