CollateralSubstitutionRequestV05

colr.010.001.05

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
%% CollateralSubstitutionRequestV05 recursion level 0 with max 0
class CollateralSubstitutionRequestV05{
    TransactionIdentification IsoMax35Text
}
CollateralSubstitutionRequestV05 *-- "1..1" Obligation9 : Obligation
CollateralSubstitutionRequestV05 *-- "0..1" Agreement4 : Agreement
CollateralSubstitutionRequestV05 *-- "1..1" CollateralSubstitution7 : CollateralSubstitutionReturn
CollateralSubstitutionRequestV05 *-- "0..1" CollateralSubstitution8 : CollateralSubstitutionDeliver
CollateralSubstitutionRequestV05 *-- "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

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
%% CollateralSubstitution7 recursion level 0 with max 1
class CollateralSubstitution7{
    CollateralSubstitutionSequence CollateralSubstitutionSequence1Code
    SubstitutionRequirement IsoActiveCurrencyAndAmount
    CollateralSubstitutionType CollateralSubstitutionType1Code
    StandardSettlementInstructions IsoMax140Text
}
CollateralSubstitution7 *-- "0..0" SecuritiesCollateral11 : SecuritiesCollateral
CollateralSubstitution7 *-- "0..0" CashCollateral5 : CashCollateral
CollateralSubstitution7 *-- "0..0" OtherCollateral11 : OtherCollateral
CollateralSubstitution7 *-- "0..1" Reference17 : LinkedReferences
%% SecuritiesCollateral11 recursion level 1 with max 1
class SecuritiesCollateral11{
    CollateralIdentification IsoMax35Text
    AssetNumber IsoMax35Text
    LimitedCoverageIndicator IsoYesNoIndicator
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
}
SecuritiesCollateral11 *-- "1..1" SecurityIdentification19 : SecurityIdentification
SecuritiesCollateral11 *-- "0..1" IDateAndDateTime2Choice : MaturityDate
SecuritiesCollateral11 *-- "1..1" IFinancialInstrumentQuantity33Choice : Quantity
SecuritiesCollateral11 *-- "0..1" Price7 : Price
SecuritiesCollateral11 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
SecuritiesCollateral11 *-- "0..1" BlockChainAddressWallet3 : BlockChainAddressOrWallet
SecuritiesCollateral11 *-- "1..1" ISafekeepingPlaceFormat29Choice : SafekeepingPlace
SecuritiesCollateral11 *-- "0..1" SettlementDetails206 : 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
%% OtherCollateral11 recursion level 1 with max 1
class OtherCollateral11{
    CollateralIdentification IsoMax35Text
    AssetNumber IsoMax35Text
    LetterOfCreditIdentification IsoMax35Text
    LetterOfCreditAmount IsoActiveCurrencyAndAmount
    GuaranteeAmount IsoActiveCurrencyAndAmount
    LimitedCoverageIndicator IsoYesNoIndicator
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
}
OtherCollateral11 *-- "0..1" OtherTypeOfCollateral3 : OtherTypeOfCollateral
OtherCollateral11 *-- "0..1" IDateFormat14Choice : IssueDate
OtherCollateral11 *-- "0..1" IDateFormat14Choice : ExpiryDate
OtherCollateral11 *-- "0..1" IPartyIdentification178Choice : Issuer
OtherCollateral11 *-- "0..1" ISafekeepingPlaceFormat29Choice : SafekeepingPlace
OtherCollateral11 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
OtherCollateral11 *-- "0..1" BlockChainAddressWallet3 : BlockChainAddressOrWallet
%% Reference17 recursion level 1 with max 1
class Reference17{
    CollateralSubstitutionRequestIdentification IsoMax35Text
    CollateralSubstitutionResponseIdentification IsoMax35Text
}
  

CollateralSubstitution7 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
%% CollateralSubstitution8 recursion level 0 with max 1
class CollateralSubstitution8{
    CollateralSubstitutionSequence CollateralSubstitutionSequence1Code
    SubstitutionRequirement IsoActiveCurrencyAndAmount
    CollateralSubstitutionType CollateralSubstitutionType1Code
    StandardSettlementInstructions IsoMax140Text
}
CollateralSubstitution8 *-- "0..0" SecuritiesCollateral12 : SecuritiesCollateral
CollateralSubstitution8 *-- "0..0" CashCollateral3 : CashCollateral
CollateralSubstitution8 *-- "0..0" OtherCollateral9 : OtherCollateral
CollateralSubstitution8 *-- "0..1" Reference17 : LinkedReferences
%% SecuritiesCollateral12 recursion level 1 with max 1
class SecuritiesCollateral12{
    CollateralIdentification IsoMax35Text
    LimitedCoverageIndicator IsoYesNoIndicator
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
    ValueDate IsoISODate
}
SecuritiesCollateral12 *-- "1..1" SecurityIdentification19 : SecurityIdentification
SecuritiesCollateral12 *-- "0..1" IDateAndDateTime2Choice : MaturityDate
SecuritiesCollateral12 *-- "1..1" IFinancialInstrumentQuantity33Choice : Quantity
SecuritiesCollateral12 *-- "0..1" Price7 : Price
SecuritiesCollateral12 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
SecuritiesCollateral12 *-- "0..1" BlockChainAddressWallet3 : BlockChainAddressOrWallet
SecuritiesCollateral12 *-- "1..1" ISafekeepingPlaceFormat29Choice : SafekeepingPlace
SecuritiesCollateral12 *-- "0..1" SettlementDetails206 : 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
%% OtherCollateral9 recursion level 1 with max 1
class OtherCollateral9{
    CollateralIdentification IsoMax35Text
    LetterOfCreditIdentification IsoMax35Text
    LetterOfCreditAmount IsoActiveCurrencyAndAmount
    GuaranteeAmount IsoActiveCurrencyAndAmount
    LimitedCoverageIndicator IsoYesNoIndicator
    ValueDate IsoISODate
    ExchangeRate IsoBaseOneRate
    MarketValue IsoActiveCurrencyAndAmount
    Haircut IsoPercentageRate
    CollateralValue IsoActiveCurrencyAndAmount
}
OtherCollateral9 *-- "0..1" OtherTypeOfCollateral3 : OtherTypeOfCollateral
OtherCollateral9 *-- "0..1" IDateFormat14Choice : IssueDate
OtherCollateral9 *-- "0..1" IDateFormat14Choice : ExpiryDate
OtherCollateral9 *-- "0..1" IPartyIdentification178Choice : Issuer
OtherCollateral9 *-- "0..1" ISafekeepingPlaceFormat29Choice : SafekeepingPlace
OtherCollateral9 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
OtherCollateral9 *-- "0..1" BlockChainAddressWallet3 : BlockChainAddressOrWallet
%% Reference17 recursion level 1 with max 1
class Reference17{
    CollateralSubstitutionRequestIdentification IsoMax35Text
    CollateralSubstitutionResponseIdentification IsoMax35Text
}
  

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

classDiagram
    class IOuterRecord
    CollateralSubstitutionRequestV05 --|> IOuterRecord : Implements
    CollateralSubstitutionRequestV05Document --|> IOuterDocument~CollateralSubstitutionRequestV05~ : Implements
    class IOuterDocument~CollateralSubstitutionRequestV05~ {
        CollateralSubstitutionRequestV05 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CollateralSubstitutionRequestV05Document *-- CollateralSubstitutionRequestV05 : 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.05">
    <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="_J4YkgygrEeyB747fKu7_rw"
  previousVersion="_vvBH0YFrEeWtPe6Crjmeug"
  name="CollateralSubstitutionRequestV05"
  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="_L9Kq4XoIEeSUmamj3OpPWw"
  xmlTag="CollSbstitnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_J4YkiSgrEeyB747fKu7_rw"
    previousVersion="_vvBH04FrEeWtPe6Crjmeug"
    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="_J4YkiygrEeyB747fKu7_rw"
    previousVersion="_vvBH1YFrEeWtPe6Crjmeug"
    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="_J4YkjSgrEeyB747fKu7_rw"
    previousVersion="_vvBH14FrEeWtPe6Crjmeug"
    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="_J4YkjygrEeyB747fKu7_rw"
    previousVersion="_vvBH2YFrEeWtPe6Crjmeug"
    name="CollateralSubstitutionReturn"
    definition="Provides details about the collateral that will be returned."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CollSbstitnRtr"
    complexType="_UpuLTSqSEeyR9JrVGfaMKw" />
  <messageBuildingBlock
    xmi:id="_J4YkkSgrEeyB747fKu7_rw"
    previousVersion="_vvBH24FrEeWtPe6Crjmeug"
    name="CollateralSubstitutionDeliver"
    definition="Provides details about the collateral that will be delivered."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CollSbstitnDlvr"
    complexType="_WKR_ESqSEeyR9JrVGfaMKw" />
  <messageBuildingBlock
    xmi:id="_J4YkkygrEeyB747fKu7_rw"
    previousVersion="_vvBH3YFrEeWtPe6Crjmeug"
    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="05" />
</messageDefinition>

ISO Building Blocks

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