ForwardIntentToPayNotificationV02

tsmt.045.001.02

Scope The ForwardIntentToPayNotification message is forwarded by the matching application from one primary bank to the other primary bank 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 ForwardIntentToPayNotification message is a copy of the IntentToPayNotification message received by the matching application and forwarded to the other primary bank for information. No response is expected.

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
%% ForwardIntentToPayNotificationV02 recursion level 0 with max 0
ForwardIntentToPayNotificationV02 *-- "1..1" MessageIdentification1 : NotificationIdentification
ForwardIntentToPayNotificationV02 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
ForwardIntentToPayNotificationV02 *-- "1..1" DocumentIdentification3 : EstablishedBaselineIdentification
ForwardIntentToPayNotificationV02 *-- "1..1" TransactionStatus4 : TransactionStatus
ForwardIntentToPayNotificationV02 *-- "0..2" DocumentIdentification5 : UserTransactionReference
ForwardIntentToPayNotificationV02 *-- "1..1" BICIdentification1 : BuyerBank
ForwardIntentToPayNotificationV02 *-- "1..1" BICIdentification1 : SellerBank
ForwardIntentToPayNotificationV02 *-- "1..1" IntentToPay2 : IntentToPay
ForwardIntentToPayNotificationV02 *-- "0..1" PendingActivity2 : RequestForAction
  

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

EstablishedBaselineIdentification building block

Unique identification assigned by the matching application to the baseline when it is established. Identifies a document by a unique identification and a version. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification3 recursion level 0 with max 1
class DocumentIdentification3{
    Identification IsoMax35Text
    Version IsoNumber
}
  

DocumentIdentification3 members

TransactionStatus building block

Identifies the status of the transaction by means of a code. Identifies the status of the transaction by means of a code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionStatus4 recursion level 0 with max 1
class TransactionStatus4{
    Status BaselineStatus3Code
}
  

TransactionStatus4 members

UserTransactionReference building block

Reference to the transaction for the financial institutions involved in this transaction. Identifies a document by a unique identification and its issuer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification5 recursion level 0 with max 1
class DocumentIdentification5{
    Identification IsoMax35Text
}
DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

DocumentIdentification5 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
%% IntentToPay2 recursion level 0 with max 1
class IntentToPay2{
    ExpectedPaymentDate IsoISODate
}
IntentToPay2 *-- "1..1" IBreakDown1Choice : Breakdown
IntentToPay2 *-- "0..1" SettlementTerms3 : SettlementTerms
%% IBreakDown1Choice recursion level 1 with max 1
%% SettlementTerms3 recursion level 1 with max 1
SettlementTerms3 *-- "0..1" IFinancialInstitutionIdentification4Choice : CreditorAgent
SettlementTerms3 *-- "1..1" CashAccount24 : CreditorAccount
  

IntentToPay2 members

RequestForAction building block

Next processing step required. Specifies the event that require an action from one of the parties to the trade transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PendingActivity2 recursion level 0 with max 1
class PendingActivity2{
    Type Action2Code
    Description IsoMax140Text
}
  

PendingActivity2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ForwardIntentToPayNotificationV02 --|> IOuterRecord : Implements
    ForwardIntentToPayNotificationV02Document --|> IOuterDocument~ForwardIntentToPayNotificationV02~ : Implements
    class IOuterDocument~ForwardIntentToPayNotificationV02~ {
        ForwardIntentToPayNotificationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ForwardIntentToPayNotificationV02Document *-- ForwardIntentToPayNotificationV02 : 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.045.001.02">
    <FwdInttToPayNtfctn>
        <NtfctnId>
            <!-- NotificationIdentification inner content -->
        </NtfctnId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <EstblishdBaselnId>
            <!-- EstablishedBaselineIdentification inner content -->
        </EstblishdBaselnId>
        <TxSts>
            <!-- TransactionStatus inner content -->
        </TxSts>
        <UsrTxRef>
            <!-- UserTransactionReference inner content -->
        </UsrTxRef>
        <BuyrBk>
            <!-- BuyerBank inner content -->
        </BuyrBk>
        <SellrBk>
            <!-- SellerBank inner content -->
        </SellrBk>
        <InttToPay>
            <!-- IntentToPay inner content -->
        </InttToPay>
        <ReqForActn>
            <!-- RequestForAction inner content -->
        </ReqForActn>
    </FwdInttToPayNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_hEp5QRVaEeOCqpkCrPgk4g"
  previousVersion="_o9cY-NE8Ed-BzquC8wXy7w_-293305328"
  name="ForwardIntentToPayNotificationV02"
  definition="Scope&#xD;&#xA;The ForwardIntentToPayNotification message is forwarded by the matching application from one primary bank to the other primary bank 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 ForwardIntentToPayNotification message is a copy of the IntentToPayNotification message received by the matching application and forwarded to the other primary bank for information. No response is expected."
  registrationStatus="Registered"
  messageSet="_1a374FXOEeOkkLyrDUP66g"
  xmlTag="FwdInttToPayNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_hEp5QxVaEeOCqpkCrPgk4g"
    previousVersion="_o9cY-dE8Ed-BzquC8wXy7w_-1911719018"
    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="_hEp5RRVaEeOCqpkCrPgk4g"
    previousVersion="_o9cY-tE8Ed-BzquC8wXy7w_-1913566608"
    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="_hEp5RxVaEeOCqpkCrPgk4g"
    previousVersion="_o9cY-9E8Ed-BzquC8wXy7w_-1903407456"
    name="EstablishedBaselineIdentification"
    definition="Unique identification assigned by the matching application to the baseline when it is established."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="EstblishdBaselnId"
    complexType="_RJNBwdp-Ed-ak6NoX_4Aeg_-1127047102" />
  <messageBuildingBlock
    xmi:id="_hEp5SRVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ8NE8Ed-BzquC8wXy7w_-1902481395"
    name="TransactionStatus"
    definition="Identifies the status of the transaction by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxSts"
    complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
  <messageBuildingBlock
    xmi:id="_hEp5SxVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ8dE8Ed-BzquC8wXy7w_89089762"
    name="UserTransactionReference"
    definition="Reference to the transaction for the financial institutions involved in this transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="UsrTxRef"
    complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
  <messageBuildingBlock
    xmi:id="_hEp5TRVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ8tE8Ed-BzquC8wXy7w_97401247"
    name="BuyerBank"
    definition="The financial institution of the buyer, uniquely identified by its BIC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BuyrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_hEp5TxVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ89E8Ed-BzquC8wXy7w_99248879"
    name="SellerBank"
    definition="The financial institution of the seller, uniquely identified by its BIC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SellrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_hEp5URVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ9NE8Ed-BzquC8wXy7w_2032766900"
    name="IntentToPay"
    definition="Provides the details of the intention to pay."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="InttToPay"
    complexType="_9-CfYRVaEeOCqpkCrPgk4g" />
  <messageBuildingBlock
    xmi:id="_hEp5UxVaEeOCqpkCrPgk4g"
    previousVersion="_o9mJ9dE8Ed-BzquC8wXy7w_112177835"
    name="RequestForAction"
    definition="Next processing step required."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ReqForActn"
    complexType="_RaowBtp-Ed-ak6NoX_4Aeg_-888447978" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="045"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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