InterestPaymentResponseV04

colr.014.001.04

Scope The InterestPaymentResponse 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 This is a response to the InterestPaymentRequest message and the amount of interest requested or advised can be accepted or rejected.

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

Usage The InterestPaymentResponse message is sent in response to the InterestPaymentRequest in order to accept or reject the amount of interest requested or advised. A rejection reason and information can be provide if the InterestPaymentRequest is being rejected.

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
%% InterestPaymentResponseV04 recursion level 0 with max 0
class InterestPaymentResponseV04{
    TransactionIdentification IsoMax35Text
}
InterestPaymentResponseV04 *-- "1..1" Obligation4 : Obligation
InterestPaymentResponseV04 *-- "1..1" Agreement4 : Agreement
InterestPaymentResponseV04 *-- "0..1" InterestAmount2 : InterestDueToA
InterestPaymentResponseV04 *-- "0..1" InterestAmount2 : InterestDueToB
InterestPaymentResponseV04 *-- "1..1" InterestResponse1 : InterestResponse
InterestPaymentResponseV04 *-- "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
%% Obligation4 recursion level 0 with max 1
class Obligation4{
    ExposureType ExposureType5Code
}
Obligation4 *-- "1..1" IPartyIdentification100Choice : PartyA
Obligation4 *-- "0..1" IPartyIdentification100Choice : ServicingPartyA
Obligation4 *-- "1..1" IPartyIdentification100Choice : PartyB
Obligation4 *-- "0..1" IPartyIdentification100Choice : ServicingPartyB
Obligation4 *-- "0..1" CollateralAccount2 : CollateralAccountIdentification
Obligation4 *-- "1..1" IDateAndDateTimeChoice : ValuationDate
%% IPartyIdentification100Choice recursion level 1 with max 1
%% IPartyIdentification100Choice recursion level 1 with max 1
%% IPartyIdentification100Choice recursion level 1 with max 1
%% IPartyIdentification100Choice recursion level 1 with max 1
%% CollateralAccount2 recursion level 1 with max 1
class CollateralAccount2{
    Identification IsoMax35Text
    Name IsoMax70Text
}
CollateralAccount2 *-- "0..1" ICollateralAccountIdentificationType2Choice : Type
%% IDateAndDateTimeChoice recursion level 1 with max 1
  

Obligation4 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
%% InterestAmount2 recursion level 0 with max 1
class InterestAmount2{
    AccruedInterestAmount IsoActiveCurrencyAndAmount
    InterestMethod InterestMethod1Code
    DayCountBasis InterestComputationMethod2Code
    AppliedWithholdingTax IsoYesNoIndicator
    CalculationMethod CalculationMethod1Code
    CalculationFrequency Frequency1Code
    StandardSettlementInstructions IsoMax140Text
    AdditionalInformation IsoMax210Text
}
InterestAmount2 *-- "1..1" IDateAndDateTimeChoice : ValueDate
InterestAmount2 *-- "1..1" DatePeriodDetails : InterestPeriod
InterestAmount2 *-- "0..1" IInterestRate1Choice : InterestRate
InterestAmount2 *-- "1..1" ICollateralPurpose1Choice : CollateralPurpose
InterestAmount2 *-- "0..1" CollateralBalance1 : OpeningCollateralBalance
InterestAmount2 *-- "1..1" CollateralBalance1 : ClosingCollateralBalance
%% IDateAndDateTimeChoice recursion level 1 with max 1
%% DatePeriodDetails recursion level 1 with max 1
class DatePeriodDetails{
    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
}
  

InterestAmount2 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
%% InterestAmount2 recursion level 0 with max 1
class InterestAmount2{
    AccruedInterestAmount IsoActiveCurrencyAndAmount
    InterestMethod InterestMethod1Code
    DayCountBasis InterestComputationMethod2Code
    AppliedWithholdingTax IsoYesNoIndicator
    CalculationMethod CalculationMethod1Code
    CalculationFrequency Frequency1Code
    StandardSettlementInstructions IsoMax140Text
    AdditionalInformation IsoMax210Text
}
InterestAmount2 *-- "1..1" IDateAndDateTimeChoice : ValueDate
InterestAmount2 *-- "1..1" DatePeriodDetails : InterestPeriod
InterestAmount2 *-- "0..1" IInterestRate1Choice : InterestRate
InterestAmount2 *-- "1..1" ICollateralPurpose1Choice : CollateralPurpose
InterestAmount2 *-- "0..1" CollateralBalance1 : OpeningCollateralBalance
InterestAmount2 *-- "1..1" CollateralBalance1 : ClosingCollateralBalance
%% IDateAndDateTimeChoice recursion level 1 with max 1
%% DatePeriodDetails recursion level 1 with max 1
class DatePeriodDetails{
    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
}
  

InterestAmount2 members

InterestResponse building block

Provides details on the response to the interest payment request. Provides details about the reponse to the interest payment request. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InterestResponse1 recursion level 0 with max 1
class InterestResponse1{
    ResponseType Status4Code
    RejectionReasonInformation IsoMax140Text
    InterestPaymentRequestIdentification IsoMax35Text
}
InterestResponse1 *-- "0..1" IRejectionReason21FormatChoice : RejectionReason
%% IRejectionReason21FormatChoice recursion level 1 with max 1
  

InterestResponse1 members

SupplementaryData building block

Additional information that can not be captured in the structured fields 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 InterestPaymentResponseV04 implementation follows a specific implementaiton pattern. First of all, InterestPaymentResponseV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, InterestPaymentResponseV04Document implements IOuterDocument. Because InterestPaymentResponseV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type InterestPaymentResponseV04.

classDiagram
    class IOuterRecord
    InterestPaymentResponseV04 --|> IOuterRecord : Implements
    InterestPaymentResponseV04Document --|> IOuterDocument~InterestPaymentResponseV04~ : Implements
    class IOuterDocument~InterestPaymentResponseV04~ {
        InterestPaymentResponseV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    InterestPaymentResponseV04Document *-- InterestPaymentResponseV04 : 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.014.001.04">
    <IntrstPmtRspn>
        <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>
        <IntrstRspn>
            <!-- InterestResponse inner content -->
        </IntrstRspn>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </IntrstPmtRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_CRyfgYFsEeWtPe6Crjmeug"
  nextVersions="_J4YkyygrEeyB747fKu7_rw"
  previousVersion="_977eoWNnEeSIWbZ6by9dnA"
  name="InterestPaymentResponseV04"
  definition="Scope&#xD;&#xA;The InterestPaymentResponse 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;This is a response to the InterestPaymentRequest message and the amount of interest requested or advised can be accepted or rejected.&#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 InterestPaymentResponse message is sent in response to the InterestPaymentRequest in order to accept or reject the amount of interest requested or advised. A rejection reason and information can be provide if the InterestPaymentRequest is being rejected."
  registrationStatus="Registered"
  messageSet="_J0aB9KV_EeW0_oPI5GRpwg"
  xmlTag="IntrstPmtRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_CRyfg4FsEeWtPe6Crjmeug"
    nextVersions="_J4Yk0ygrEeyB747fKu7_rw"
    previousVersion="_977eo2NnEeSIWbZ6by9dnA"
    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="_CRyfhYFsEeWtPe6Crjmeug"
    nextVersions="_J4Yk1SgrEeyB747fKu7_rw"
    previousVersion="_GigdcGNpEeSIWbZ6by9dnA"
    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="_wtu2IYFvEeWtPe6Crjmeug" />
  <messageBuildingBlock
    xmi:id="_CRyfh4FsEeWtPe6Crjmeug"
    nextVersions="_J4Yk1ygrEeyB747fKu7_rw"
    previousVersion="_977erWNnEeSIWbZ6by9dnA"
    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="_CRyfiYFsEeWtPe6Crjmeug"
    nextVersions="_J4Yk2SgrEeyB747fKu7_rw"
    previousVersion="_977er2NnEeSIWbZ6by9dnA"
    name="InterestDueToA"
    definition="Provides details on the interest amount due to party A."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="IntrstDueToA"
    complexType="_SQk5gtp-Ed-ak6NoX_4Aeg_1384086328" />
  <messageBuildingBlock
    xmi:id="_CRyfi4FsEeWtPe6Crjmeug"
    nextVersions="_J4Yk2ygrEeyB747fKu7_rw"
    previousVersion="_977esWNnEeSIWbZ6by9dnA"
    name="InterestDueToB"
    definition="Provides details on the interest amount due to party B."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="IntrstDueToB"
    complexType="_SQk5gtp-Ed-ak6NoX_4Aeg_1384086328" />
  <messageBuildingBlock
    xmi:id="_CRyfjYFsEeWtPe6Crjmeug"
    nextVersions="_J4Yk3SgrEeyB747fKu7_rw"
    previousVersion="_977es2NnEeSIWbZ6by9dnA"
    name="InterestResponse"
    definition="Provides details on the response to the interest payment request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="IntrstRspn"
    complexType="_Qki1hNp-Ed-ak6NoX_4Aeg_1044109408" />
  <messageBuildingBlock
    xmi:id="_CRyfj4FsEeWtPe6Crjmeug"
    nextVersions="_J4Yk3ygrEeyB747fKu7_rw"
    previousVersion="_977etWNnEeSIWbZ6by9dnA"
    name="SupplementaryData"
    definition="Additional information that can not be captured in the structured fields and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="colr"
    messageFunctionality="014"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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