sese.006.001.03
Scope An instructing party, for example, a transfer agent, sends the TransferInCancellationRequest message to the executing party, for example, 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
%% TransferInCancellationRequestV03 recursion level 0 with max 0
TransferInCancellationRequestV03 *-- "1..1" MessageIdentification1 : MessageIdentification
TransferInCancellationRequestV03 *-- "1..1" References11 : References
TransferInCancellationRequestV03 *-- "0..1" TransferReference1 : CancellationByReference
TransferInCancellationRequestV03 *-- "0..1" TransferIn5 : CancellationByTransferInDetails
TransferInCancellationRequestV03 *-- "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 |
References building block
Reference to the transaction identifier issued by the counterparty. Building block may also be used to reference a previous transaction, or tie a set of messages together. Reference to the transaction identifier issued by the counterparty. Building block may also be used to reference a previous transaction, or tie a set of messages together. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% References11 recursion level 0 with max 1
References11 *-- "0..1" AdditionalReference2 : PoolReference
References11 *-- "0..1" AdditionalReference2 : PreviousReference
References11 *-- "0..1" AdditionalReference2 : RelatedReference
References11 *-- "0..1" AdditionalReference2 : CounterpartyReference
%% AdditionalReference2 recursion level 1 with max 1
class AdditionalReference2{
Reference IsoMax35Text
MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
%% AdditionalReference2 recursion level 1 with max 1
class AdditionalReference2{
Reference IsoMax35Text
MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
%% AdditionalReference2 recursion level 1 with max 1
class AdditionalReference2{
Reference IsoMax35Text
MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
%% AdditionalReference2 recursion level 1 with max 1
class AdditionalReference2{
Reference IsoMax35Text
MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
References11 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PoolReference | Collective reference identifying a set of messages. | AdditionalReference2 - Optional 0..1 |
| PreviousReference | Reference of the linked message that was previously sent. | AdditionalReference2 - Optional 0..1 |
| RelatedReference | Reference to a linked message that was previously received. | AdditionalReference2 - Optional 0..1 |
| CounterpartyReference | Unambiguous identification of the transfer allocated by the counterparty. | AdditionalReference2 - 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
%% TransferIn5 recursion level 0 with max 1
TransferIn5 *-- "1..0" Transfer16 : TransferDetails
TransferIn5 *-- "1..1" InvestmentAccount22 : AccountDetails
TransferIn5 *-- "1..1" DeliverInformation8 : SettlementDetails
TransferIn5 *-- "0..0" Extension1 : Extension
%% Transfer16 recursion level 1 with max 1
class Transfer16{
HoldingsPlanType HoldingsPlanType1Code
OwnAccountTransferIndicator IsoYesNoIndicator
NonStandardSettlementInformation IsoMax350Text
}
Transfer16 *-- "0..1" IDateFormat1Choice : TransferDate
Transfer16 *-- "1..1" FinancialInstrument13 : FinancialInstrumentDetails
Transfer16 *-- "1..1" FinancialInstrumentQuantity1 : TotalUnitsNumber
%% 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
%% DeliverInformation8 recursion level 1 with max 1
class DeliverInformation8{
SettlementAmount IsoActiveCurrencyAndAmount
StampDuty StampDutyType2Code
NetAmount IsoActiveCurrencyAndAmount
PhysicalTransfer PhysicalTransferType1Code
}
DeliverInformation8 *-- "1..1" DeliveringPartiesAndAccount8 : SettlementPartiesDetails
DeliverInformation8 *-- "0..0" Charge20 : ChargeDetails
DeliverInformation8 *-- "0..0" Commission12 : CommissionDetails
DeliverInformation8 *-- "0..0" Tax15 : TaxDetails
DeliverInformation8 *-- "0..1" DeliveryParameters4 : PhysicalTransferDetails
%% Extension1 recursion level 1 with max 1
class Extension1{
PlaceAndName IsoMax350Text
Text IsoMax350Text
}
TransferIn5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TransferDetails | General information related to the transfer of a financial instrument. | Transfer16 - Unknown 1..0 |
| 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. | DeliverInformation8 - 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 TransferInCancellationRequestV03 implementation follows a specific implementaiton pattern. First of all, TransferInCancellationRequestV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, TransferInCancellationRequestV03Document implements IOuterDocument. Because TransferInCancellationRequestV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type TransferInCancellationRequestV03.
classDiagram
class IOuterRecord
TransferInCancellationRequestV03 --|> IOuterRecord : Implements
TransferInCancellationRequestV03Document --|> IOuterDocument~TransferInCancellationRequestV03~ : Implements
class IOuterDocument~TransferInCancellationRequestV03~ {
TransferInCancellationRequestV03 Message
}
Document wrapper for serialization
The only real purpose TransferInCancellationRequestV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:sese.006.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using TransferInCancellationRequestV03.ToDocument() method. The returned TransferInCancellationRequestV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
TransferInCancellationRequestV03Document *-- TransferInCancellationRequestV03 : 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.03">
<TrfInCxlReq>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<Refs>
<!-- References inner content -->
</Refs>
<CxlByRef>
<!-- CancellationByReference inner content -->
</CxlByRef>
<CxlByTrfInDtls>
<!-- CancellationByTransferInDetails inner content -->
</CxlByTrfInDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
</TrfInCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5Eu2kfpbEeCPwaG9zjUPNQ"
nextVersions="_EmP8gRgCEeKqWJINzXcn5g"
previousVersion="_Iq5JiNE6Ed-BzquC8wXy7w_-1614969547"
name="TransferInCancellationRequestV03"
definition="Scope
An instructing party, for example, a transfer agent, sends the TransferInCancellationRequest message to the executing party, for example, 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="TrfInCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<xors
xmi:id="_5Eu2lfpbEeCPwaG9zjUPNQ"
name="Operation1"
registrationStatus="Provisionally Registered"
impactedMessageBuildingBlocks="_5Eu2rfpbEeCPwaG9zjUPNQ _5Eu2sfpbEeCPwaG9zjUPNQ" />
<messageBuildingBlock
xmi:id="_5Eu2nfpbEeCPwaG9zjUPNQ"
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="_OLS9P_r3EeCJc7cZxzE2fg"
name="References"
definition="Reference to the transaction identifier issued by the counterparty. Building block may also be used to reference a previous transaction, or tie a set of messages together."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Refs"
complexType="_Vv7Tofr0EeCJc7cZxzE2fg" />
<messageBuildingBlock
xmi:id="_5Eu2rfpbEeCPwaG9zjUPNQ"
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="_5Eu2sfpbEeCPwaG9zjUPNQ"
name="CancellationByTransferInDetails"
definition="The transfer in request message to cancel."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CxlByTrfInDtls"
complexType="_Tcg_Mfr3EeCJc7cZxzE2fg" />
<messageBuildingBlock
xmi:id="_5Eu2tfpbEeCPwaG9zjUPNQ"
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="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.