supl.009.001.01
The DTCCCAPASD1 messge extends ISO corporate action movement preliminary advice message with DTCC corporate action elements not covered in the standard message.
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 %% DTCCCAPASD1V01 recursion level 0 with max 0 DTCCCAPASD1V01 *-- "0..1" CorporateActionGeneralInformationSD1 : CorporateActionGeneralInformation DTCCCAPASD1V01 *-- "0..1" CorporateActionMovementSecuritiesMovementDetailsSD1 : CorporateActionMovementSecuritiesMovementDetails DTCCCAPASD1V01 *-- "0..1" CorporateActionMovementCashMovementDetailsSD1 : CorporateActionMovementCashMovementDetails
Now, we will zero-in one-by-one on each of these building blocks.
CorporateActionGeneralInformation building block
Extension block for the information to be extended as corporate action general information. Provides additional information regarding corporate action general information details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionGeneralInformationSD1 recursion level 0 with max 1 class CorporateActionGeneralInformationSD1{ PlaceAndName IsoMax350Text RecordDate IsoISODate }
CorporateActionGeneralInformationSD1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | xPath to the element that is being extended. | IsoMax350Text - Required 1..1 |
RecordDate | Date at which positions are stuck at the end of the day to note which parties will receive the relevant amount of entitlement, due to be distributed on payment date. DTC (The Depository Trust Corporation) and its Participants may use this as a reference. | IsoISODate - Optional 0..1 |
CorporateActionMovementSecuritiesMovementDetails building block
Extension block for the information to be extended as corporate action movement securities movement details. Provides additional information regarding corporate action movement securities movement rate details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionMovementSecuritiesMovementDetailsSD1 recursion level 0 with max 1 class CorporateActionMovementSecuritiesMovementDetailsSD1{ PlaceAndName IsoMax350Text CreditDebitIndicator CreditDebitCode ReasonCode DTCAdjustmentPaymentType1Code ContraParticipantNumber IsoMax8Text } CorporateActionMovementSecuritiesMovementDetailsSD1 *-- "0..1" IFinancialInstrumentQuantity15Choice : TransactionQuantity CorporateActionMovementSecuritiesMovementDetailsSD1 *-- "0..1" IDateFormat22Choice : EarliestPaymentDate %% IFinancialInstrumentQuantity15Choice recursion level 1 with max 1 %% IDateFormat22Choice recursion level 1 with max 1
CorporateActionMovementSecuritiesMovementDetailsSD1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | xPath to the element that is being extended. | IsoMax350Text - Required 1..1 |
CreditDebitIndicator | Indicates whether the value is a debit or a credit. | CreditDebitCode - Required 1..1 |
TransactionQuantity | Resulting quantity of securities concerned in this transaction. | IFinancialInstrumentQuantity15Choice - Optional 0..1 |
ReasonCode | Transaction reason. | DTCAdjustmentPaymentType1Code - Optional 0..1 |
ContraParticipantNumber | Transaction contra participant identification when shares are distributed / delivered to / from another participant. | IsoMax8Text - Optional 0..1 |
EarliestPaymentDate | Date/Time on which the posting / draft of the securities is scheduled to take place for a transaction. | IDateFormat22Choice - Optional 0..1 |
CorporateActionMovementCashMovementDetails building block
Extension block for the information to be extended as corporate action movement cash movement details. Provides additional information regarding corporate action movement details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionMovementCashMovementDetailsSD1 recursion level 0 with max 1 class CorporateActionMovementCashMovementDetailsSD1{ PlaceAndName IsoMax350Text CreditDebitIndicator CreditDebitCode TransactionAmount IsoRestrictedFINActiveCurrencyAndAmount TransactionReasonCode DTCAdjustmentPaymentType1Code ContraParticipantNumber IsoMax8Text } CorporateActionMovementCashMovementDetailsSD1 *-- "0..1" IDateFormat22Choice : EarliestPaymentDate %% IDateFormat22Choice recursion level 1 with max 1
CorporateActionMovementCashMovementDetailsSD1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | xPath to the element that is being extended. | IsoMax350Text - Required 1..1 |
CreditDebitIndicator | Indicates whether the value is a debit or a credit. | CreditDebitCode - Required 1..1 |
TransactionAmount | Resulting cash amount concerned in this transaction. | IsoRestrictedFINActiveCurrencyAndAmount - Optional 0..1 |
TransactionReasonCode | Transaction reason. | DTCAdjustmentPaymentType1Code - Optional 0..1 |
ContraParticipantNumber | Transaction contra participant identification when shares are distributed / delivered to / from another participant. | IsoMax8Text - Optional 0..1 |
EarliestPaymentDate | Date/Time on which the posting / draft of cash is scheduled to take place for a transaction. | IDateFormat22Choice - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the DTCCCAPASD1V01 implementation follows a specific implementaiton pattern. First of all, DTCCCAPASD1V01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, DTCCCAPASD1V01Document implements IOuterDocument. Because DTCCCAPASD1V01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type DTCCCAPASD1V01.
classDiagram class IOuterRecord DTCCCAPASD1V01 --|> IOuterRecord : Implements DTCCCAPASD1V01Document --|> IOuterDocument~DTCCCAPASD1V01~ : Implements class IOuterDocument~DTCCCAPASD1V01~ { DTCCCAPASD1V01 Message }
Document wrapper for serialization
The only real purpose DTCCCAPASD1V01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:supl.009.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using DTCCCAPASD1V01.ToDocument() method. The returned DTCCCAPASD1V01Document value will serialize correctly according to ISO 20022 standards.
classDiagram DTCCCAPASD1V01Document *-- DTCCCAPASD1V01 : 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:supl.009.001.01">
<DTCCCAPASD1>
<CorpActnGnlInf>
<!-- CorporateActionGeneralInformation inner content -->
</CorpActnGnlInf>
<CorpActnMvmntSctiesMvmntDtls>
<!-- CorporateActionMovementSecuritiesMovementDetails inner content -->
</CorpActnMvmntSctiesMvmntDtls>
<CorpActnMvmntCshMvmntDtls>
<!-- CorporateActionMovementCashMovementDetails inner content -->
</CorpActnMvmntCshMvmntDtls>
</DTCCCAPASD1>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_1Njf8TL3EeKU9IrkkToqcw_1609512939"
nextVersions="_eaasRV2lEeOb__BffbPEig"
name="DTCCCAPASD1V01"
definition="The DTCCCAPASD1 messge extends ISO corporate action movement preliminary advice message with DTCC corporate action elements not covered in the standard message."
registrationStatus="Provisionally Registered"
xmlTag="DTCCCAPASD1"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_1Njf8jL3EeKU9IrkkToqcw_-1573085315"
nextVersions="_eaasR12lEeOb__BffbPEig"
name="CorporateActionGeneralInformation"
definition="Extension block for the information to be extended as corporate action general information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CorpActnGnlInf"
complexType="_1WgAlTL3EeKU9IrkkToqcw_352744377">
<semanticMarkup
xmi:id="_e-o4Yg5lEeO42pgjaJ50lw"
type="Synonym">
<elements
xmi:id="_e-o4Yw5lEeO42pgjaJ50lw"
name="context"
value="DTCC" />
<elements
xmi:id="_e-o4ZA5lEeO42pgjaJ50lw"
name="value"
value="Event (Details)" />
</semanticMarkup>
</messageBuildingBlock>
<messageBuildingBlock
xmi:id="_1Njf8zL3EeKU9IrkkToqcw_1688378389"
nextVersions="_eaasT12lEeOb__BffbPEig"
name="CorporateActionMovementSecuritiesMovementDetails"
definition="Extension block for the information to be extended as corporate action movement securities movement details."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="CorpActnMvmntSctiesMvmntDtls"
complexType="_1XPncDL3EeKU9IrkkToqcw_-1866819272">
<semanticMarkup
xmi:id="_e-o4Zg5lEeO42pgjaJ50lw"
type="Synonym">
<elements
xmi:id="_e-o4Zw5lEeO42pgjaJ50lw"
name="context"
value="DTCC" />
<elements
xmi:id="_e-o4aA5lEeO42pgjaJ50lw"
name="value"
value="Payout (Securities)" />
</semanticMarkup>
</messageBuildingBlock>
<messageBuildingBlock
xmi:id="_1Njf9DL3EeKU9IrkkToqcw_51361216"
nextVersions="_eaasV12lEeOb__BffbPEig"
name="CorporateActionMovementCashMovementDetails"
definition="Extension block for the information to be extended as corporate action movement cash movement details."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="CorpActnMvmntCshMvmntDtls"
complexType="_1XF2cDL3EeKU9IrkkToqcw_1038258673">
<semanticMarkup
xmi:id="_e-o4gA5lEeO42pgjaJ50lw"
type="Synonym">
<elements
xmi:id="_e-o4gQ5lEeO42pgjaJ50lw"
name="context"
value="DTCC" />
<elements
xmi:id="_e-o4gg5lEeO42pgjaJ50lw"
name="value"
value="Payout (Cash)" />
</semanticMarkup>
</messageBuildingBlock>
<messageDefinitionIdentifier
businessArea="supl"
messageFunctionality="009"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.