InterestPaymentRequestV05

colr.013.001.05

Scope The InterestPaymentRequest message is sent by either;

• the collateral taker or its collateral manager to the collateral giver or its collateral manager, or
• the collateral giver or its collateral manager to the collateral taker or its collateral manager It is used to request payment or advise the amount due for interest calculated for a specified period. The interest is based on the amount of collateral that has been held during the calculation period. It is possible to send these messages on a bi-lateral basis for matching.

The message definition is intended for use with the ISO20022 Business Application Header.

Usage The InterestPaymentRequest message is used to advise the interest amount calculated for a specific period or request payment for an interest amount for a specific period.

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
%% InterestPaymentRequestV05 recursion level 0 with max 0
class InterestPaymentRequestV05{
    TransactionIdentification IsoMax35Text
}
InterestPaymentRequestV05 *-- "1..1" Obligation9 : Obligation
InterestPaymentRequestV05 *-- "1..1" Agreement4 : Agreement
InterestPaymentRequestV05 *-- "0..1" InterestAmount4 : InterestDueToA
InterestPaymentRequestV05 *-- "0..1" InterestAmount4 : InterestDueToB
InterestPaymentRequestV05 *-- "0..1" InterestResult1 : NetAmountDetails
InterestPaymentRequestV05 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

TransactionIdentification building block

Unambiguous identification of the transaction as know by the instructing party. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

Obligation building block

Provides information like the identification of the party or parties associated with the collateral agreement, the exposure type and the valuation date. Provides information like the identification of the party or parties associated with the collateral agreement, the exposure type and the valuation date. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Obligation9 recursion level 0 with max 1
class Obligation9{
    ExposureType ExposureType11Code
}
Obligation9 *-- "1..1" IPartyIdentification178Choice : PartyA
Obligation9 *-- "0..1" IPartyIdentification178Choice : ServicingPartyA
Obligation9 *-- "1..1" IPartyIdentification178Choice : PartyB
Obligation9 *-- "0..1" IPartyIdentification178Choice : ServicingPartyB
Obligation9 *-- "0..1" CollateralAccount3 : CollateralAccountIdentification
Obligation9 *-- "0..1" BlockChainAddressWallet5 : BlockChainAddressOrWallet
Obligation9 *-- "1..1" IDateAndDateTime2Choice : ValuationDate
%% IPartyIdentification178Choice recursion level 1 with max 1
%% IPartyIdentification178Choice recursion level 1 with max 1
%% IPartyIdentification178Choice recursion level 1 with max 1
%% IPartyIdentification178Choice recursion level 1 with max 1
%% CollateralAccount3 recursion level 1 with max 1
class CollateralAccount3{
    Identification IsoMax35Text
    Name IsoMax70Text
}
CollateralAccount3 *-- "0..1" ICollateralAccountIdentificationType3Choice : Type
%% BlockChainAddressWallet5 recursion level 1 with max 1
class BlockChainAddressWallet5{
    Identification IsoMax140Text
    Name IsoMax70Text
}
BlockChainAddressWallet5 *-- "0..1" ICollateralAccountIdentificationType3Choice : Type
%% IDateAndDateTime2Choice recursion level 1 with max 1
  

Obligation9 members

Agreement building block

Agreement details for the over the counter market. Agreement details for the over the counter market. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Agreement4 recursion level 0 with max 1
class Agreement4{
    AgreementDetails IsoMax140Text
    AgreementIdentification IsoMax140Text
    AgreementDate IsoISODate
    BaseCurrency ActiveCurrencyCode
}
Agreement4 *-- "0..1" IAgreementFramework1Choice : AgreementFramework
%% IAgreementFramework1Choice recursion level 1 with max 1
  

Agreement4 members

InterestDueToA building block

Provides details on the interest amount due to party A. Provides the elements related to the interest amount calculation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InterestAmount4 recursion level 0 with max 1
class InterestAmount4{
    InterestRequestSequence InterestRequestSequence1Code
    AccruedInterestAmount IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
    InterestMethod InterestMethod1Code
    DayCountBasis InterestComputationMethod2Code
    AppliedWithholdingTax IsoYesNoIndicator
    CalculationMethod CalculationMethod1Code
    CalculationFrequency Frequency1Code
    StandardSettlementInstructions IsoMax140Text
    AdditionalInformation IsoMax210Text
}
InterestAmount4 *-- "1..1" DatePeriod2 : InterestPeriod
InterestAmount4 *-- "0..1" IInterestRate1Choice : InterestRate
InterestAmount4 *-- "1..1" ICollateralPurpose1Choice : CollateralPurpose
InterestAmount4 *-- "0..1" CollateralBalance1 : OpeningCollateralBalance
InterestAmount4 *-- "1..1" CollateralBalance1 : ClosingCollateralBalance
InterestAmount4 *-- "0..1" Reference20 : ReferenceDetails
%% DatePeriod2 recursion level 1 with max 1
class DatePeriod2{
    FromDate IsoISODate
    ToDate IsoISODate
}
%% IInterestRate1Choice recursion level 1 with max 1
%% ICollateralPurpose1Choice recursion level 1 with max 1
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
%% Reference20 recursion level 1 with max 1
class Reference20{
    InterestPaymentRequestIdentification IsoMax35Text
    InterestPaymentResponseIdentification IsoMax35Text
}
  

InterestAmount4 members

InterestDueToB building block

Provides details on the interest amount due to party B. Provides the elements related to the interest amount calculation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InterestAmount4 recursion level 0 with max 1
class InterestAmount4{
    InterestRequestSequence InterestRequestSequence1Code
    AccruedInterestAmount IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
    InterestMethod InterestMethod1Code
    DayCountBasis InterestComputationMethod2Code
    AppliedWithholdingTax IsoYesNoIndicator
    CalculationMethod CalculationMethod1Code
    CalculationFrequency Frequency1Code
    StandardSettlementInstructions IsoMax140Text
    AdditionalInformation IsoMax210Text
}
InterestAmount4 *-- "1..1" DatePeriod2 : InterestPeriod
InterestAmount4 *-- "0..1" IInterestRate1Choice : InterestRate
InterestAmount4 *-- "1..1" ICollateralPurpose1Choice : CollateralPurpose
InterestAmount4 *-- "0..1" CollateralBalance1 : OpeningCollateralBalance
InterestAmount4 *-- "1..1" CollateralBalance1 : ClosingCollateralBalance
InterestAmount4 *-- "0..1" Reference20 : ReferenceDetails
%% DatePeriod2 recursion level 1 with max 1
class DatePeriod2{
    FromDate IsoISODate
    ToDate IsoISODate
}
%% IInterestRate1Choice recursion level 1 with max 1
%% ICollateralPurpose1Choice recursion level 1 with max 1
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
%% Reference20 recursion level 1 with max 1
class Reference20{
    InterestPaymentRequestIdentification IsoMax35Text
    InterestPaymentResponseIdentification IsoMax35Text
}
  

InterestAmount4 members

NetAmountDetails building block

Provides the net interest amount due to A or due to B in case of collateral held and posted during a period. Consideration, such as amount of money, paid or received in exchange for an amount of money that has been invested, loaned or borrowed for a certain period. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InterestResult1 recursion level 0 with max 1
class InterestResult1{
    InterestDueToA IsoActiveCurrencyAndAmount
    InterestDueToB IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
    InterestMethod InterestMethod1Code
}
InterestResult1 *-- "0..1" CollateralBalance1 : OpeningCollateralBalance
InterestResult1 *-- "1..1" CollateralBalance1 : ClosingCollateralBalance
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
%% CollateralBalance1 recursion level 1 with max 1
class CollateralBalance1{
    HeldByPartyA IsoActiveCurrencyAndAmount
    HeldByPartyB IsoActiveCurrencyAndAmount
}
  

InterestResult1 members

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
  

SupplementaryData1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    InterestPaymentRequestV05 --|> IOuterRecord : Implements
    InterestPaymentRequestV05Document --|> IOuterDocument~InterestPaymentRequestV05~ : Implements
    class IOuterDocument~InterestPaymentRequestV05~ {
        InterestPaymentRequestV05 Message
     }
  

Document wrapper for serialization

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

classDiagram
    InterestPaymentRequestV05Document *-- InterestPaymentRequestV05 : 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:colr.013.001.05">
    <IntrstPmtReq>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <Oblgtn>
            <!-- Obligation inner content -->
        </Oblgtn>
        <Agrmt>
            <!-- Agreement inner content -->
        </Agrmt>
        <IntrstDueToA>
            <!-- InterestDueToA inner content -->
        </IntrstDueToA>
        <IntrstDueToB>
            <!-- InterestDueToB inner content -->
        </IntrstDueToB>
        <NetAmtDtls>
            <!-- NetAmountDetails inner content -->
        </NetAmtDtls>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </IntrstPmtReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_J4YktygrEeyB747fKu7_rw"
  previousVersion="_CRyfcYFsEeWtPe6Crjmeug"
  name="InterestPaymentRequestV05"
  definition="Scope&#xD;&#xA;The InterestPaymentRequest message is sent by either;&#xD;&#xA;- the collateral taker or its collateral manager to the collateral giver or its collateral manager, or&#xD;&#xA;- the collateral giver or its collateral manager to the collateral taker or its collateral manager&#xD;&#xA;It is used to request payment or advise the amount due for interest calculated for a specified period. The interest is based on the amount of collateral that has been held during the calculation period. It is possible to send these messages on a bi-lateral basis for matching.&#xD;&#xA;&#xD;&#xA;The message definition is intended for use with the ISO20022 Business Application Header.&#xD;&#xA;&#xD;&#xA;Usage&#xD;&#xA;The InterestPaymentRequest message is used to advise the interest amount calculated for a specific period or request payment for an interest amount for a specific period."
  registrationStatus="Registered"
  messageSet="_L9Kq4XoIEeSUmamj3OpPWw"
  xmlTag="IntrstPmtReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_J4YkvSgrEeyB747fKu7_rw"
    previousVersion="_CRyfc4FsEeWtPe6Crjmeug"
    name="TransactionIdentification"
    definition="Unambiguous identification of the transaction as know by the instructing party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_J4YkvygrEeyB747fKu7_rw"
    previousVersion="_CRyfdYFsEeWtPe6Crjmeug"
    name="Obligation"
    definition="Provides information like the identification of the party or parties associated with the collateral agreement, the exposure type and the valuation date."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Oblgtn"
    complexType="_wc_c4SgsEeyB747fKu7_rw" />
  <messageBuildingBlock
    xmi:id="_J4YkwSgrEeyB747fKu7_rw"
    previousVersion="_CRyfd4FsEeWtPe6Crjmeug"
    name="Agreement"
    definition="Agreement details for the over the counter market."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Agrmt"
    complexType="_6T7_AYbEEeWguotXa4lFgg" />
  <messageBuildingBlock
    xmi:id="_J4YkwygrEeyB747fKu7_rw"
    previousVersion="_CRyfeYFsEeWtPe6Crjmeug"
    name="InterestDueToA"
    definition="Provides details on the interest amount due to party A."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="IntrstDueToA"
    complexType="_AFlH0StNEeyOa655cLd-DQ" />
  <messageBuildingBlock
    xmi:id="_J4YkxSgrEeyB747fKu7_rw"
    previousVersion="_CRyfe4FsEeWtPe6Crjmeug"
    name="InterestDueToB"
    definition="Provides details on the interest amount due to party B."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="IntrstDueToB"
    complexType="_AFlH0StNEeyOa655cLd-DQ" />
  <messageBuildingBlock
    xmi:id="_J4YkxygrEeyB747fKu7_rw"
    previousVersion="_CRyffYFsEeWtPe6Crjmeug"
    name="NetAmountDetails"
    definition="Provides the net interest amount due to A or due to B in case of collateral held and posted during a period."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="NetAmtDtls"
    complexType="_SQuqh9p-Ed-ak6NoX_4Aeg_1199217791" />
  <messageBuildingBlock
    xmi:id="_J4YkySgrEeyB747fKu7_rw"
    previousVersion="_CRyff4FsEeWtPe6Crjmeug"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="colr"
    messageFunctionality="013"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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