CollateralSubstitutionRequestV04

colr.010.001.04

Scope The CollateralSubstitutionRequest message is sent by either the collateral giver or its collateral manager to the collateral taker or its collateral manager. It is used to request a substitution of collateral by specifying the collateral to be returned and proposing the new type(s) of collateral to be delivered. Note: There are cases where the collateral taker can initiate the CollateralSubstitutionRequest message, for example in case of breach in the concentration limit.

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

Usage The CollateralSubstitutionRequest message can be sent by either the collateral giver or collateral taker in order to substitute collateral that is already held by the other party.

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
%% CollateralSubstitutionRequestV04 recursion level 0 with max 0
class CollateralSubstitutionRequestV04{
    TransactionIdentification IsoMax35Text
}
CollateralSubstitutionRequestV04 *-- "1..1" Obligation4 : Obligation
CollateralSubstitutionRequestV04 *-- "0..1" Agreement4 : Agreement
CollateralSubstitutionRequestV04 *-- "1..1" CollateralSubstitution5 : CollateralSubstitutionReturn
CollateralSubstitutionRequestV04 *-- "0..1" CollateralSubstitution4 : CollateralSubstitutionDeliver
CollateralSubstitutionRequestV04 *-- "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

CollateralSubstitutionReturn building block

Provides details about the collateral that will be returned. Provides details about the collateral that will be substituted. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CollateralSubstitution5 recursion level 0 with max 1
class CollateralSubstitution5{
    CollateralSubstitutionSequence CollateralSubstitutionSequence1Code
    SubstitutionRequirement IsoActiveCurrencyAndAmount
    CollateralSubstitutionType CollateralSubstitutionType1Code
    StandardSettlementInstructions IsoMax140Text
}
CollateralSubstitution5 *-- "0..0" SecuritiesCollateral7 : SecuritiesCollateral
CollateralSubstitution5 *-- "0..0" CashCollateral5 : CashCollateral
CollateralSubstitution5 *-- "0..0" OtherCollateral7 : OtherCollateral
CollateralSubstitution5 *-- "0..1" Reference17 : LinkedReferences
%% SecuritiesCollateral7 recursion level 1 with max 1
class SecuritiesCollateral7{
    CollateralIdentification IsoMax35Text
    AssetNumber IsoMax35Text
    LimitedCoverageIndicator IsoYesNoIndicator
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
}
SecuritiesCollateral7 *-- "1..1" SecurityIdentification19 : SecurityIdentification
SecuritiesCollateral7 *-- "0..1" IDateAndDateTimeChoice : MaturityDate
SecuritiesCollateral7 *-- "1..1" IFinancialInstrumentQuantity1Choice : Quantity
SecuritiesCollateral7 *-- "0..1" Price2 : Price
SecuritiesCollateral7 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
SecuritiesCollateral7 *-- "1..1" ISafekeepingPlaceFormat10Choice : SafekeepingPlace
SecuritiesCollateral7 *-- "0..1" SettlementDetails102 : SettlementParameters
%% CashCollateral5 recursion level 1 with max 1
class CashCollateral5{
    CollateralIdentification IsoMax35Text
    AssetNumber IsoMax35Text
    DepositAmount IsoActiveCurrencyAndAmount
    DepositType DepositType1Code
    MaturityDate IsoISODate
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    CollateralValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
}
CashCollateral5 *-- "0..1" IAccountIdentification4Choice : CashAccountIdentification
%% OtherCollateral7 recursion level 1 with max 1
class OtherCollateral7{
    CollateralIdentification IsoMax35Text
    AssetNumber IsoMax35Text
    LetterOfCreditIdentification IsoMax35Text
    LetterOfCreditAmount IsoActiveCurrencyAndAmount
    GuaranteeAmount IsoActiveCurrencyAndAmount
    LimitedCoverageIndicator IsoYesNoIndicator
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
}
OtherCollateral7 *-- "0..1" OtherTypeOfCollateral2 : OtherTypeOfCollateral
OtherCollateral7 *-- "0..1" IDateFormat14Choice : IssueDate
OtherCollateral7 *-- "0..1" IDateFormat14Choice : ExpiryDate
OtherCollateral7 *-- "0..1" IPartyIdentification100Choice : Issuer
OtherCollateral7 *-- "0..1" ISafekeepingPlaceFormat10Choice : SafekeepingPlace
OtherCollateral7 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
%% Reference17 recursion level 1 with max 1
class Reference17{
    CollateralSubstitutionRequestIdentification IsoMax35Text
    CollateralSubstitutionResponseIdentification IsoMax35Text
}
  

CollateralSubstitution5 members

CollateralSubstitutionDeliver building block

Provides details about the collateral that will be delivered. Provides details about the collateral that will be substituted. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CollateralSubstitution4 recursion level 0 with max 1
class CollateralSubstitution4{
    CollateralSubstitutionSequence CollateralSubstitutionSequence1Code
    SubstitutionRequirement IsoActiveCurrencyAndAmount
    CollateralSubstitutionType CollateralSubstitutionType1Code
    StandardSettlementInstructions IsoMax140Text
}
CollateralSubstitution4 *-- "0..0" SecuritiesCollateral5 : SecuritiesCollateral
CollateralSubstitution4 *-- "0..0" CashCollateral3 : CashCollateral
CollateralSubstitution4 *-- "0..0" OtherCollateral5 : OtherCollateral
CollateralSubstitution4 *-- "0..1" Reference17 : LinkedReferences
%% SecuritiesCollateral5 recursion level 1 with max 1
class SecuritiesCollateral5{
    CollateralIdentification IsoMax35Text
    LimitedCoverageIndicator IsoYesNoIndicator
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
}
SecuritiesCollateral5 *-- "1..1" SecurityIdentification19 : SecurityIdentification
SecuritiesCollateral5 *-- "0..1" IDateAndDateTimeChoice : MaturityDate
SecuritiesCollateral5 *-- "1..1" IFinancialInstrumentQuantity1Choice : Quantity
SecuritiesCollateral5 *-- "0..1" Price2 : Price
SecuritiesCollateral5 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
SecuritiesCollateral5 *-- "1..1" ISafekeepingPlaceFormat10Choice : SafekeepingPlace
SecuritiesCollateral5 *-- "0..1" SettlementDetails102 : SettlementParameters
%% CashCollateral3 recursion level 1 with max 1
class CashCollateral3{
    CollateralIdentification IsoMax35Text
    DepositAmount IsoActiveCurrencyAndAmount
    DepositType DepositType1Code
    MaturityDate IsoISODate
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    CollateralValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
}
CashCollateral3 *-- "0..1" IAccountIdentification4Choice : CashAccountIdentification
%% OtherCollateral5 recursion level 1 with max 1
class OtherCollateral5{
    CollateralIdentification IsoMax35Text
    LetterOfCreditIdentification IsoMax35Text
    LetterOfCreditAmount IsoActiveCurrencyAndAmount
    GuaranteeAmount IsoActiveCurrencyAndAmount
    LimitedCoverageIndicator IsoYesNoIndicator
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
}
OtherCollateral5 *-- "0..1" OtherTypeOfCollateral2 : OtherTypeOfCollateral
OtherCollateral5 *-- "0..1" IDateFormat14Choice : IssueDate
OtherCollateral5 *-- "0..1" IDateFormat14Choice : ExpiryDate
OtherCollateral5 *-- "0..1" IPartyIdentification100Choice : Issuer
OtherCollateral5 *-- "0..1" ISafekeepingPlaceFormat10Choice : SafekeepingPlace
OtherCollateral5 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
%% Reference17 recursion level 1 with max 1
class Reference17{
    CollateralSubstitutionRequestIdentification IsoMax35Text
    CollateralSubstitutionResponseIdentification IsoMax35Text
}
  

CollateralSubstitution4 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 CollateralSubstitutionRequestV04 implementation follows a specific implementaiton pattern. First of all, CollateralSubstitutionRequestV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CollateralSubstitutionRequestV04Document implements IOuterDocument. Because CollateralSubstitutionRequestV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CollateralSubstitutionRequestV04.

classDiagram
    class IOuterRecord
    CollateralSubstitutionRequestV04 --|> IOuterRecord : Implements
    CollateralSubstitutionRequestV04Document --|> IOuterDocument~CollateralSubstitutionRequestV04~ : Implements
    class IOuterDocument~CollateralSubstitutionRequestV04~ {
        CollateralSubstitutionRequestV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CollateralSubstitutionRequestV04Document *-- CollateralSubstitutionRequestV04 : 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.010.001.04">
    <CollSbstitnReq>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <Oblgtn>
            <!-- Obligation inner content -->
        </Oblgtn>
        <Agrmt>
            <!-- Agreement inner content -->
        </Agrmt>
        <CollSbstitnRtr>
            <!-- CollateralSubstitutionReturn inner content -->
        </CollSbstitnRtr>
        <CollSbstitnDlvr>
            <!-- CollateralSubstitutionDeliver inner content -->
        </CollSbstitnDlvr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CollSbstitnReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_vvBH0YFrEeWtPe6Crjmeug"
  nextVersions="_J4YkgygrEeyB747fKu7_rw"
  previousVersion="_w4W-AVnMEeSPgY23yCMQSQ"
  name="CollateralSubstitutionRequestV04"
  definition="Scope&#xD;&#xA;The CollateralSubstitutionRequest message is sent by either the collateral giver or its collateral manager to the collateral taker or its collateral manager. It is used to request a substitution of collateral by specifying the collateral to be returned and proposing the new type(s) of collateral to be delivered. Note: There are cases where the collateral taker can initiate the CollateralSubstitutionRequest message, for example in case of breach in the concentration limit.&#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 CollateralSubstitutionRequest message can be sent by either the collateral giver or collateral taker in order to substitute collateral that is already held by the other party."
  registrationStatus="Registered"
  messageSet="_J0aB9KV_EeW0_oPI5GRpwg"
  xmlTag="CollSbstitnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_vvBH04FrEeWtPe6Crjmeug"
    nextVersions="_J4YkiSgrEeyB747fKu7_rw"
    previousVersion="_w4W-A1nMEeSPgY23yCMQSQ"
    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="_vvBH1YFrEeWtPe6Crjmeug"
    nextVersions="_J4YkiygrEeyB747fKu7_rw"
    previousVersion="_YF0qkGNmEeSIWbZ6by9dnA"
    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="_vvBH14FrEeWtPe6Crjmeug"
    nextVersions="_J4YkjSgrEeyB747fKu7_rw"
    previousVersion="_w4W-DVnMEeSPgY23yCMQSQ"
    name="Agreement"
    definition="Agreement details for the over the counter market."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Agrmt"
    complexType="_6T7_AYbEEeWguotXa4lFgg" />
  <messageBuildingBlock
    xmi:id="_vvBH2YFrEeWtPe6Crjmeug"
    nextVersions="_J4YkjygrEeyB747fKu7_rw"
    previousVersion="_w4W-D1nMEeSPgY23yCMQSQ"
    name="CollateralSubstitutionReturn"
    definition="Provides details about the collateral that will be returned."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CollSbstitnRtr"
    complexType="_1LsPEYFvEeWtPe6Crjmeug" />
  <messageBuildingBlock
    xmi:id="_vvBH24FrEeWtPe6Crjmeug"
    nextVersions="_J4YkkSgrEeyB747fKu7_rw"
    previousVersion="_w4W-EVnMEeSPgY23yCMQSQ"
    name="CollateralSubstitutionDeliver"
    definition="Provides details about the collateral that will be delivered."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CollSbstitnDlvr"
    complexType="_tOZoYYFvEeWtPe6Crjmeug" />
  <messageBuildingBlock
    xmi:id="_vvBH3YFrEeWtPe6Crjmeug"
    nextVersions="_J4YkkygrEeyB747fKu7_rw"
    previousVersion="_w4W-E1nMEeSPgY23yCMQSQ"
    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="010"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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