IntentToPayNotificationV01

tsmt.044.001.01

Scope The IntentToPayNotification message is sent by a party to the matching application in order to provide details about a future payment. This message contains details about an intention to pay a certain amount, on a certain date, in relation to one or several transactions known to the matching application. Usage The IntentToPayNotification message can be sent by a party to the transaction at any time as long as the transaction is established and not yet closed. The message is unsolicited, that is, it is not sent in response to another 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
%% IntentToPayNotificationV01 recursion level 0 with max 0
IntentToPayNotificationV01 *-- "1..1" MessageIdentification1 : NotificationIdentification
IntentToPayNotificationV01 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
IntentToPayNotificationV01 *-- "0..1" SimpleIdentificationInformation : SubmitterTransactionReference
IntentToPayNotificationV01 *-- "1..1" BICIdentification1 : BuyerBank
IntentToPayNotificationV01 *-- "1..1" BICIdentification1 : SellerBank
IntentToPayNotificationV01 *-- "1..1" IntentToPay1 : IntentToPay
  

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

NotificationIdentification building block

Identifies the notification message. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

TransactionIdentification building block

Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

SubmitterTransactionReference building block

Reference to the transaction for the requesting financial institution. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

BuyerBank building block

The financial institution of the buyer, uniquely identified by its BIC. . Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

SellerBank building block

The financial institution of the seller, uniquely identified by its BIC. . Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

IntentToPay building block

Provides the details of the intention to pay. Specifies the details of an intention to pay based on purchase orders or commercial invoice. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IntentToPay1 recursion level 0 with max 1
class IntentToPay1{
    ExpectedPaymentDate IsoISODate
}
IntentToPay1 *-- "1..1" ReportLine3 : ByPurchaseOrder
IntentToPay1 *-- "1..1" ReportLine4 : ByCommercialInvoice
IntentToPay1 *-- "0..1" SettlementTerms2 : SettlementTerms
%% ReportLine3 recursion level 1 with max 1
class ReportLine3{
    NetAmount IsoCurrencyAndAmount
}
ReportLine3 *-- "1..1" DocumentIdentification7 : PurchaseOrderReference
ReportLine3 *-- "0..0" Adjustment4 : Adjustment
%% ReportLine4 recursion level 1 with max 1
class ReportLine4{
    NetAmount IsoCurrencyAndAmount
}
ReportLine4 *-- "1..1" InvoiceIdentification1 : CommercialDocumentReference
ReportLine4 *-- "0..0" Adjustment4 : Adjustment
ReportLine4 *-- "1..0" ReportLine2 : BreakdownByPurchaseOrder
%% SettlementTerms2 recursion level 1 with max 1
SettlementTerms2 *-- "0..1" IFinancialInstitutionIdentification4Choice : CreditorAgent
SettlementTerms2 *-- "1..1" CashAccount7 : CreditorAccount
  

IntentToPay1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    IntentToPayNotificationV01 --|> IOuterRecord : Implements
    IntentToPayNotificationV01Document --|> IOuterDocument~IntentToPayNotificationV01~ : Implements
    class IOuterDocument~IntentToPayNotificationV01~ {
        IntentToPayNotificationV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    IntentToPayNotificationV01Document *-- IntentToPayNotificationV01 : 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:tsmt.044.001.01">
    <InttToPayNtfctn>
        <NtfctnId>
            <!-- NotificationIdentification inner content -->
        </NtfctnId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <SubmitrTxRef>
            <!-- SubmitterTransactionReference inner content -->
        </SubmitrTxRef>
        <BuyrBk>
            <!-- BuyerBank inner content -->
        </BuyrBk>
        <SellrBk>
            <!-- SellerBank inner content -->
        </SellrBk>
        <InttToPay>
            <!-- IntentToPay inner content -->
        </InttToPay>
    </InttToPayNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_qS03gtE8Ed-BzquC8wXy7w_-674719643"
  nextVersions="_YyxioRVaEeOCqpkCrPgk4g"
  name="IntentToPayNotificationV01"
  definition="Scope&#xD;&#xA;The IntentToPayNotification message is sent by a party to the matching application in order to provide details about a future payment.&#xD;&#xA;This message contains details about an intention to pay a certain amount, on a certain date, in relation to one or several transactions known to the matching application.&#xD;&#xA;Usage&#xD;&#xA;The IntentToPayNotification message can be sent by a party to the transaction at any time as long as the transaction is established and not yet closed.&#xD;&#xA;The message is unsolicited, that is, it is not sent in response to another message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _urpIICeJEeOCeO5e7islRQ"
  xmlTag="InttToPayNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_qS03g9E8Ed-BzquC8wXy7w_163901085"
    nextVersions="_YyxioxVaEeOCqpkCrPgk4g"
    name="NotificationIdentification"
    definition="Identifies the notification message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="NtfctnId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_qS03hNE8Ed-BzquC8wXy7w_152820680"
    nextVersions="_YyxipRVaEeOCqpkCrPgk4g"
    name="TransactionIdentification"
    definition="Unique identification assigned by the matching application to the transaction.&#xA;This identification is to be used in any communication between the parties."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_qS03hdE8Ed-BzquC8wXy7w_1332333857"
    nextVersions="_YyxipxVaEeOCqpkCrPgk4g"
    name="SubmitterTransactionReference"
    definition="Reference to the transaction for the requesting financial institution."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SubmitrTxRef"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_qS03htE8Ed-BzquC8wXy7w_-1244476424"
    nextVersions="_YyxiqRVaEeOCqpkCrPgk4g"
    name="BuyerBank"
    definition="The financial institution of the buyer, uniquely identified by its BIC. &#xA;."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BuyrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_qS03h9E8Ed-BzquC8wXy7w_-1235239055"
    nextVersions="_YyxiqxVaEeOCqpkCrPgk4g"
    name="SellerBank"
    definition="The financial institution of the seller, uniquely identified by its BIC. &#xA;."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SellrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_qS03iNE8Ed-BzquC8wXy7w_-1879861996"
    nextVersions="_YyxirRVaEeOCqpkCrPgk4g"
    name="IntentToPay"
    definition="Provides the details of the intention to pay."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="InttToPay"
    complexType="_PzEVSdp-Ed-ak6NoX_4Aeg_-1491388962" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="044"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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