BuyInNotificationV03

secl.007.001.03

Scope The BuyInNotification message is sent by the central counterparty (CCP) to a clearing member to notify the start of the buy in process.

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

Usage The buy in process is a process by which the CCP buys in stocks to cover failed transactions; the clearing member is notified that this process has started. Depending on each CCP internal rules, this message can also be sent, as a warning, by the central counterparty to the clearing member some days before the buy in process starts.

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
%% BuyInNotificationV03 recursion level 0 with max 0
class BuyInNotificationV03{
    TransactionIdentification IsoMax35Text
}
BuyInNotificationV03 *-- "1..1" IPartyIdentification35Choice : ClearingMember
BuyInNotificationV03 *-- "0..1" BuyIn4 : NotificationDetails
BuyInNotificationV03 *-- "1..1" SettlementObligation7 : OriginalSettlementObligation
BuyInNotificationV03 *-- "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 known 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.

ClearingMember building block

Provides the identification of the clearing member (individual clearing member or general clearing member). Choice of identification of a party. The party can be identified by giving a BIC or a proprietary code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IPartyIdentification35Choice recursion level 0 with max 1
  

PartyIdentification35Choice members

Member name Description Data Type / Multiplicity

NotificationDetails building block

Indicates if the message is a notification or a warning and gives the option to specify the buy in date. Specifies elements related to the notification (or warn) sent by the central counterparty to the clearing member in the context of the buy in process. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BuyIn4 recursion level 0 with max 1
class BuyIn4{
    WarningIndicator IsoYesNoIndicator
    CancellationLimitDate IsoISODate
    BuyInReversionDate IsoISODate
}
BuyIn4 *-- "1..1" IDateFormat15Choice : ExpectedBuyInDate
%% IDateFormat15Choice recursion level 1 with max 1
  

BuyIn4 members

Member name Description Data Type / Multiplicity
WarningIndicator Indicates whether the message is a warning only or a notification. IsoYesNoIndicator - Optional 0..1
ExpectedBuyInDate Provides the date at which the buy-in will occur. IDateFormat15Choice - Required 1..1
CancellationLimitDate Identifies the latest date by which the buy-in operation can be cancelled. IsoISODate - Optional 0..1
BuyInReversionDate Identifies the date by which the buy-in operation is reversed by the CCP. IsoISODate - Optional 0..1

OriginalSettlementObligation building block

Provides details about the original settlement obligation that did not settle and for which the buy in process will be launched. Provides details about the settlement obligation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SettlementObligation7 recursion level 0 with max 1
class SettlementObligation7{
    CSDTransactionIdentification IsoMax35Text
    CentralCounterpartyTransactionIdentification IsoMax35Text
    PreviousBuyInIdentification IsoMax35Text
    IntendedSettlementDate IsoISODate
    TradeDate IsoISODate
}
SettlementObligation7 *-- "0..1" SecuritiesAccount19 : DeliveryAccount
SettlementObligation7 *-- "0..1" ISafekeepingPlaceFormat7Choice : SafekeepingPlace
SettlementObligation7 *-- "0..1" SecuritiesAccount19 : SafekeepingAccount
SettlementObligation7 *-- "0..1" IPartyIdentification35Choice : ClearingSegment
SettlementObligation7 *-- "0..1" PartyIdentificationAndAccount31 : NonClearingMember
SettlementObligation7 *-- "1..1" SecurityIdentification14 : FinancialInstrumentIdentification
SettlementObligation7 *-- "0..1" Price4 : DealPrice
SettlementObligation7 *-- "1..1" IFinancialInstrumentQuantity1Choice : Quantity
SettlementObligation7 *-- "0..1" IPartyIdentification34Choice : Depository
SettlementObligation7 *-- "0..1" IFinancialInstrumentQuantity1Choice : RemainingQuantityToBeSettled
SettlementObligation7 *-- "1..1" AmountAndDirection27 : SettlementAmount
SettlementObligation7 *-- "0..1" AmountAndDirection27 : RemainingAmountToBeSettled
%% SecuritiesAccount19 recursion level 1 with max 1
class SecuritiesAccount19{
    Identification IsoMax35Text
    Name IsoMax70Text
}
SecuritiesAccount19 *-- "0..1" GenericIdentification30 : Type
%% ISafekeepingPlaceFormat7Choice recursion level 1 with max 1
%% SecuritiesAccount19 recursion level 1 with max 1
class SecuritiesAccount19{
    Identification IsoMax35Text
    Name IsoMax70Text
}
SecuritiesAccount19 *-- "0..1" GenericIdentification30 : Type
%% IPartyIdentification35Choice recursion level 1 with max 1
%% PartyIdentificationAndAccount31 recursion level 1 with max 1
PartyIdentificationAndAccount31 *-- "1..1" IPartyIdentification33Choice : Identification
PartyIdentificationAndAccount31 *-- "0..1" AlternatePartyIdentification4 : AlternateIdentification
PartyIdentificationAndAccount31 *-- "0..1" PartyTextInformation1 : AdditionalInformation
PartyIdentificationAndAccount31 *-- "0..1" SecuritiesAccount18 : ClearingAccount
%% SecurityIdentification14 recursion level 1 with max 1
class SecurityIdentification14{
    ISIN IsoISINIdentifier
    Description IsoMax140Text
}
SecurityIdentification14 *-- "0..0" OtherIdentification1 : OtherIdentification
%% Price4 recursion level 1 with max 1
class Price4{
    Type PriceValueType7Code
}
Price4 *-- "1..1" IPriceRateOrAmountChoice : Value
%% IFinancialInstrumentQuantity1Choice recursion level 1 with max 1
%% IPartyIdentification34Choice recursion level 1 with max 1
%% IFinancialInstrumentQuantity1Choice recursion level 1 with max 1
%% AmountAndDirection27 recursion level 1 with max 1
class AmountAndDirection27{
    Amount IsoActiveCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
    OriginalCurrencyAndOrderedAmount IsoActiveOrHistoricCurrencyAndAmount
}
AmountAndDirection27 *-- "0..1" ForeignExchangeTerms17 : ForeignExchangeDetails
%% AmountAndDirection27 recursion level 1 with max 1
class AmountAndDirection27{
    Amount IsoActiveCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
    OriginalCurrencyAndOrderedAmount IsoActiveOrHistoricCurrencyAndAmount
}
AmountAndDirection27 *-- "0..1" ForeignExchangeTerms17 : ForeignExchangeDetails
  

SettlementObligation7 members

Member name Description Data Type / Multiplicity
CSDTransactionIdentification Last reference given by the settlement platform (this is the central securities depository) to the transaction (non settled instruction). IsoMax35Text - Optional 0..1
CentralCounterpartyTransactionIdentification Reference of the transaction (non settled instruction) given by the central counterparty. IsoMax35Text - Optional 0..1
PreviousBuyInIdentification Original buy-in identification number in case an event causes a generation of a new buy-in identification. IsoMax35Text - Optional 0..1
DeliveryAccount An account opened by the central counterparty in the name of the clearing member within the account structure, for settlement purposes (gives information about the clearing member account at central counterparty). SecuritiesAccount19 - Optional 0..1
SafekeepingPlace Place where the securities are safe-kept, physically or notionally. This place can be, for example, a local custodian, a Central Securities Depository (CSD) or an International Central Securities Depository (ICSD). ISafekeepingPlaceFormat7Choice - Optional 0..1
SafekeepingAccount Clearing member account at the central securities depository. SecuritiesAccount19 - Optional 0..1
ClearingSegment Clearing organisation that will clear the trade. Note: This field allows clearing member firm to segregate flows coming from clearing counterparty’s clearing system. Indeed, clearing member firms receive messages from the same system (same sender) and this field allows them to know if the message is related to equities or derivatives. IPartyIdentification35Choice - Optional 0..1
NonClearingMember Provides the identification for the non-clearing member and account. PartyIdentificationAndAccount31 - Optional 0..1
IntendedSettlementDate Provides the intended settlement date of the position. IsoISODate - Optional 0..1
FinancialInstrumentIdentification Provides details about the security identification. SecurityIdentification14 - Required 1..1
TradeDate Provides the trade date. IsoISODate - Optional 0..1
DealPrice Provides the price of the trade. Price4 - Optional 0..1
Quantity Provides the quantity of the trade. IFinancialInstrumentQuantity1Choice - Required 1..1
Depository Place where settlement of the securities takes place. IPartyIdentification34Choice - Optional 0..1
RemainingQuantityToBeSettled Provides the remaining quantity to be settled. IFinancialInstrumentQuantity1Choice - Optional 0..1
SettlementAmount Provides the amount to be settled. AmountAndDirection27 - Required 1..1
RemainingAmountToBeSettled Provides the remaining amount to be settled. AmountAndDirection27 - Optional 0..1

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

Member name Description Data Type / Multiplicity
PlaceAndName Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. IsoMax350Text - Optional 0..1
Envelope Technical element wrapping the supplementary data. IsoSupplementaryDataEnvelope1 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    BuyInNotificationV03 --|> IOuterRecord : Implements
    BuyInNotificationV03Document --|> IOuterDocument~BuyInNotificationV03~ : Implements
    class IOuterDocument~BuyInNotificationV03~ {
        BuyInNotificationV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    BuyInNotificationV03Document *-- BuyInNotificationV03 : 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:secl.007.001.03">
    <BuyInNtfctn>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <ClrMmb>
            <!-- ClearingMember inner content -->
        </ClrMmb>
        <NtfctnDtls>
            <!-- NotificationDetails inner content -->
        </NtfctnDtls>
        <OrgnlSttlmOblgtn>
            <!-- OriginalSettlementObligation inner content -->
        </OrgnlSttlmOblgtn>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </BuyInNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_1K820S0lEeSRe9rElPHBfg"
  name="BuyInNotificationV03"
  definition="Scope&#xD;&#xA;The BuyInNotification message is sent by the central counterparty (CCP) to a clearing member to notify the start of the buy in process.&#xD;&#xA;&#xD;&#xA;The message definition is intended for use with the ISO 20022 Business Application Header.&#xD;&#xA;&#xD;&#xA;Usage&#xD;&#xA;The buy in process is a process by which the CCP buys in stocks to cover failed transactions; the clearing member is notified that this process has started. Depending on each CCP internal rules, this message can also be sent, as a warning, by the central counterparty to the clearing member some days before the buy in process starts."
  registrationStatus="Registered"
  messageSet="_vZbScWwCEeSvG_1tXIrsqQ"
  xmlTag="BuyInNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_1K820y0lEeSRe9rElPHBfg"
    name="TransactionIdentificationPresenceRule"
    definition="If NotificationDetails/WarningIndicator is &quot;false&quot; or &quot;0&quot; (No), then TransactionIdentification must be present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/TransactionIdentification&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/NotificationDetails/WarningIndicator&lt;/leftOperand&gt;&lt;rightOperand&gt;false&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <messageBuildingBlock
    xmi:id="_1K821S0lEeSRe9rElPHBfg"
    name="TransactionIdentification"
    definition="Unambiguous identification of the transaction as known by the instructing party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="TxId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_1K821y0lEeSRe9rElPHBfg"
    name="ClearingMember"
    definition="Provides the identification of the clearing member (individual clearing member or general clearing member)."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ClrMmb"
    complexType="_QPYd4dp-Ed-ak6NoX_4Aeg_-1523931735" />
  <messageBuildingBlock
    xmi:id="_1K822S0lEeSRe9rElPHBfg"
    name="NotificationDetails"
    definition="Indicates if the message is a notification or a warning and gives the option to specify the buy in date."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="NtfctnDtls"
    complexType="_7xh9US9WEeS94oXWDaBauA" />
  <messageBuildingBlock
    xmi:id="_1K822y0lEeSRe9rElPHBfg"
    name="OriginalSettlementObligation"
    definition="Provides details about the original settlement obligation that did not settle and for which the buy in process will be launched."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="OrgnlSttlmOblgtn"
    complexType="_Bu5zUS9aEeS94oXWDaBauA" />
  <messageBuildingBlock
    xmi:id="_1K823S0lEeSRe9rElPHBfg"
    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="secl"
    messageFunctionality="007"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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