sese.006.001.02
Scope An instructing party, eg, a transfer agent, sends the TransferInCancellationRequest message to the executing party, eg, a transfer agent, to request the cancellation of a previously sent TransferInInstruction. Usage The TransferInCancellationRequest message is used to request cancellation of a previously sent TransferInInstruction. There are two ways to specify the transfer cancellation request. Either:
- the transfer reference of the original transfer is quoted, or,
- all the details of the original transfer (this includes TransferReference) are quoted but this is not recommended. The message identification of the TransferInInstruction message in which the transfer was conveyed may also be quoted in PreviousReference. It is also possible to request the cancellation of a TransferInInstruction message by quoting its message identification in PreviousReference.
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 %% TransferInCancellationRequestV02 recursion level 0 with max 0 TransferInCancellationRequestV02 *-- "1..1" MessageIdentification1 : MessageIdentification TransferInCancellationRequestV02 *-- "0..1" AdditionalReference2 : PreviousReference TransferInCancellationRequestV02 *-- "0..1" AdditionalReference2 : PoolReference TransferInCancellationRequestV02 *-- "0..1" AdditionalReference2 : RelatedReference TransferInCancellationRequestV02 *-- "0..1" TransferReference1 : CancellationByReference TransferInCancellationRequestV02 *-- "0..1" TransferIn3 : CancellationByTransferInDetails TransferInCancellationRequestV02 *-- "0..1" CopyInformation2 : CopyDetails
Now, we will zero-in one-by-one on each of these building blocks.
MessageIdentification building block
Reference that uniquely identifies a message from a business application standpoint. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification
classDiagram direction tb %% MessageIdentification1 recursion level 0 with max 1 class MessageIdentification1{ Identification IsoMax35Text CreationDateTime IsoISODateTime }
MessageIdentification1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identification of the message. | IsoMax35Text - Required 1..1 |
CreationDateTime | Date of creation of the message. | IsoISODateTime - Required 1..1 |
PreviousReference building block
Reference to a linked message that was previously sent. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AdditionalReference2 recursion level 0 with max 1 class AdditionalReference2{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer %% IPartyIdentification1Choice recursion level 1 with max 1
AdditionalReference2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | IPartyIdentification1Choice - Optional 0..1 |
MessageName | Name of a message. | IsoMax35Text - Optional 0..1 |
PoolReference building block
Collective reference identifying a set of messages. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AdditionalReference2 recursion level 0 with max 1 class AdditionalReference2{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer %% IPartyIdentification1Choice recursion level 1 with max 1
AdditionalReference2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | IPartyIdentification1Choice - Optional 0..1 |
MessageName | Name of a message. | IsoMax35Text - Optional 0..1 |
RelatedReference building block
Reference to a linked message that was previously received. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AdditionalReference2 recursion level 0 with max 1 class AdditionalReference2{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer %% IPartyIdentification1Choice recursion level 1 with max 1
AdditionalReference2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | IPartyIdentification1Choice - Optional 0..1 |
MessageName | Name of a message. | IsoMax35Text - Optional 0..1 |
CancellationByReference building block
Reference of the transfer to be cancelled. Reference of a transfer and of a transfer cancellation. For comparison, see the ISO20022 official specification
classDiagram direction tb %% TransferReference1 recursion level 0 with max 1 class TransferReference1{ MasterReference IsoMax35Text TransferReference IsoMax35Text ClientReference IsoMax35Text CancellationReference IsoMax35Text }
TransferReference1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MasterReference | Unique and unambiguous identifier for a group of individual transfers as assigned by the instructing party. This identifier links the individual transfers together. | IsoMax35Text - Optional 0..1 |
TransferReference | Unique and unambiguous identifier for a transfer instruction, as assigned by the instructing party. | IsoMax35Text - Required 1..1 |
ClientReference | Unique and unambiguous investor’s identification of a transfer. This reference can typically be used in a hub scenario to give the reference of the transfer as assigned by the underlying client. | IsoMax35Text - Optional 0..1 |
CancellationReference | Unique and unambiguous identifier for a transfer cancellation, as assigned by the instructing party. | IsoMax35Text - Optional 0..1 |
CancellationByTransferInDetails building block
The transfer in request message to cancel. Information about a transfer in transaction. For comparison, see the ISO20022 official specification
classDiagram direction tb %% TransferIn3 recursion level 0 with max 1 TransferIn3 *-- "1..1" Transfer6 : TransferDetails TransferIn3 *-- "1..1" FinancialInstrument13 : FinancialInstrumentDetails TransferIn3 *-- "1..1" InvestmentAccount22 : AccountDetails TransferIn3 *-- "1..1" DeliverInformation3 : SettlementDetails TransferIn3 *-- "0..0" Extension1 : Extension %% Transfer6 recursion level 1 with max 1 class Transfer6{ MasterReference IsoMax35Text TransferReference IsoMax35Text ClientReference IsoMax35Text CancellationReference IsoMax35Text OwnAccountTransferIndicator IsoYesNoIndicator NonStandardSettlementInformation IsoMax350Text } Transfer6 *-- "0..1" IDateFormat1Choice : TransferDate Transfer6 *-- "1..1" FinancialInstrumentQuantity1 : TotalUnitsNumber %% FinancialInstrument13 recursion level 1 with max 1 class FinancialInstrument13{ Name IsoMax350Text SupplementaryIdentification IsoMax35Text ClassType IsoMax35Text SecuritiesForm FormOfSecurity1Code DistributionPolicy DistributionPolicy1Code } FinancialInstrument13 *-- "1..1" ISecurityIdentification3Choice : Identification %% InvestmentAccount22 recursion level 1 with max 1 class InvestmentAccount22{ AccountName IsoMax35Text AccountDesignation IsoMax35Text SecuritiesForm FormOfSecurity1Code DematerialisedIndicator IsoYesNoIndicator IncomePreference IncomePreference1Code BeneficiaryCertificationCompletion BeneficiaryCertificationCompletion1Code } InvestmentAccount22 *-- "0..0" IPartyIdentification2Choice : OwnerIdentification InvestmentAccount22 *-- "1..1" AccountIdentification1 : AccountIdentification InvestmentAccount22 *-- "0..0" Intermediary11 : IntermediaryInformation InvestmentAccount22 *-- "0..1" IPartyIdentification2Choice : SafekeepingPlace InvestmentAccount22 *-- "0..1" IPartyIdentification2Choice : AccountServicer %% DeliverInformation3 recursion level 1 with max 1 class DeliverInformation3{ SettlementAmount IsoActiveCurrencyAndAmount StampDutyIndicator IsoYesNoIndicator NetAmount IsoActiveCurrencyAndAmount PhysicalTransferIndicator IsoYesNoIndicator } DeliverInformation3 *-- "1..1" DeliveringPartiesAndAccount4 : SettlementPartiesDetails DeliverInformation3 *-- "0..0" Charge20 : ChargeDetails DeliverInformation3 *-- "0..0" Commission12 : CommissionDetails DeliverInformation3 *-- "0..0" Tax15 : TaxDetails DeliverInformation3 *-- "0..1" DeliveryParameters4 : PhysicalTransferDetails %% Extension1 recursion level 1 with max 1 class Extension1{ PlaceAndName IsoMax350Text Text IsoMax350Text }
TransferIn3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
TransferDetails | General information related to the transfer of a financial instrument. | Transfer6 - Required 1..1 |
FinancialInstrumentDetails | Information related to the financial instrument to be received. | FinancialInstrument13 - Required 1..1 |
AccountDetails | Information related to the account into which the financial instrument is to be received. | InvestmentAccount22 - Required 1..1 |
SettlementDetails | Information related to the delivering side of the transfer. | DeliverInformation3 - Required 1..1 |
Extension | Additional information that cannot be captured in the structured elements and/or any other specific block. | Extension1 - Unknown 0..0 |
CopyDetails building block
Information provided when the message is a copy of a previous message. Information provided when the message is a copy of a previous message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CopyInformation2 recursion level 0 with max 1 class CopyInformation2{ CopyIndicator IsoYesNoIndicator } CopyInformation2 *-- "0..1" BICIdentification1 : OriginalReceiver %% BICIdentification1 recursion level 1 with max 1 class BICIdentification1{ BIC IsoBICIdentifier }
CopyInformation2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
CopyIndicator | Indicates whether the message is a copy. | IsoYesNoIndicator - Required 1..1 |
OriginalReceiver | Original receiver of the message, if this message is a copy. | BICIdentification1 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the TransferInCancellationRequestV02 implementation follows a specific implementaiton pattern. First of all, TransferInCancellationRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, TransferInCancellationRequestV02Document implements IOuterDocument. Because TransferInCancellationRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type TransferInCancellationRequestV02.
classDiagram class IOuterRecord TransferInCancellationRequestV02 --|> IOuterRecord : Implements TransferInCancellationRequestV02Document --|> IOuterDocument~TransferInCancellationRequestV02~ : Implements class IOuterDocument~TransferInCancellationRequestV02~ { TransferInCancellationRequestV02 Message }
Document wrapper for serialization
The only real purpose TransferInCancellationRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:sese.006.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using TransferInCancellationRequestV02.ToDocument() method. The returned TransferInCancellationRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram TransferInCancellationRequestV02Document *-- TransferInCancellationRequestV02 : 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:sese.006.001.02">
<TrfInCxlReqV02>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<RltdRef>
<!-- RelatedReference inner content -->
</RltdRef>
<CxlByRef>
<!-- CancellationByReference inner content -->
</CxlByRef>
<CxlByTrfInDtls>
<!-- CancellationByTransferInDetails inner content -->
</CxlByTrfInDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
</TrfInCxlReqV02>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Iq5JiNE6Ed-BzquC8wXy7w_-1614969547"
nextVersions="_5Eu2kfpbEeCPwaG9zjUPNQ"
previousVersion="_IJ9muNE6Ed-BzquC8wXy7w_-1440956956"
name="TransferInCancellationRequestV02"
definition="Scope
An instructing party, eg, a transfer agent, sends the TransferInCancellationRequest message to the executing party, eg, a transfer agent, to request the cancellation of a previously sent TransferInInstruction.
Usage
The TransferInCancellationRequest message is used to request cancellation of a previously sent TransferInInstruction.
There are two ways to specify the transfer cancellation request. Either:
- the transfer reference of the original transfer is quoted, or,
- all the details of the original transfer (this includes TransferReference) are quoted but this is not recommended.
The message identification of the TransferInInstruction message in which the transfer was conveyed may also be quoted in PreviousReference. It is also possible to request the cancellation of a TransferInInstruction message by quoting its message identification in PreviousReference."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="TrfInCxlReqV02"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<xors
xmi:id="_IrCTc9E6Ed-BzquC8wXy7w_-1592806202"
name="CancellationByReferenceOrByTransferInDetailsRule"
definition="Either CancellationByTransferInDetails or CancellationByReference may be present, but not both."
registrationStatus="Provisionally Registered"
impactedMessageBuildingBlocks="_IrCTcNE6Ed-BzquC8wXy7w_-2096566826 _IrCTcdE6Ed-BzquC8wXy7w_-1614049514" />
<messageBuildingBlock
xmi:id="_Iq5JidE6Ed-BzquC8wXy7w_-713613405"
name="MessageIdentification"
definition="Reference that uniquely identifies a message from a business application standpoint."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgId"
complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
<messageBuildingBlock
xmi:id="_Iq5JitE6Ed-BzquC8wXy7w_-1614969527"
name="PreviousReference"
definition="Reference to a linked message that was previously sent."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrvsRef"
complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
<messageBuildingBlock
xmi:id="_Iq5Ji9E6Ed-BzquC8wXy7w_-1614049462"
name="PoolReference"
definition="Collective reference identifying a set of messages."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PoolRef"
complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
<messageBuildingBlock
xmi:id="_Iq5JjNE6Ed-BzquC8wXy7w_-1614049497"
name="RelatedReference"
definition="Reference to a linked message that was previously received."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="RltdRef"
complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
<messageBuildingBlock
xmi:id="_IrCTcNE6Ed-BzquC8wXy7w_-2096566826"
name="CancellationByReference"
definition="Reference of the transfer to be cancelled."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CxlByRef"
complexType="_SwKYjdp-Ed-ak6NoX_4Aeg_-838136093" />
<messageBuildingBlock
xmi:id="_IrCTcdE6Ed-BzquC8wXy7w_-1614049514"
name="CancellationByTransferInDetails"
definition="The transfer in request message to cancel."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CxlByTrfInDtls"
complexType="_RNhhENp-Ed-ak6NoX_4Aeg_-1300755125" />
<messageBuildingBlock
xmi:id="_IrCTctE6Ed-BzquC8wXy7w_319701879"
name="CopyDetails"
definition="Information provided when the message is a copy of a previous message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CpyDtls"
complexType="_Q7Vk4tp-Ed-ak6NoX_4Aeg_-1918092012" />
<messageDefinitionIdentifier
businessArea="sese"
messageFunctionality="006"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.