sese.006.001.04
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 %% TransferInCancellationRequestV04 recursion level 0 with max 0 TransferInCancellationRequestV04 *-- "1..1" MessageIdentification1 : MessageIdentification TransferInCancellationRequestV04 *-- "1..1" References11 : References TransferInCancellationRequestV04 *-- "1..1" ICancellation2Choice : Cancellation TransferInCancellationRequestV04 *-- "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 |
Cancellation building block
Choice between cancellation by reference or by transfer details. Choice between cancellation by reference or by transfer details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ICancellation2Choice recursion level 0 with max 1
Cancellation2Choice members
Member name | Description | Data Type / Multiplicity |
---|
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 TransferInCancellationRequestV04 implementation follows a specific implementaiton pattern. First of all, TransferInCancellationRequestV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, TransferInCancellationRequestV04Document implements IOuterDocument. Because TransferInCancellationRequestV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type TransferInCancellationRequestV04.
classDiagram class IOuterRecord TransferInCancellationRequestV04 --|> IOuterRecord : Implements TransferInCancellationRequestV04Document --|> IOuterDocument~TransferInCancellationRequestV04~ : Implements class IOuterDocument~TransferInCancellationRequestV04~ { TransferInCancellationRequestV04 Message }
Document wrapper for serialization
The only real purpose TransferInCancellationRequestV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:sese.006.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using TransferInCancellationRequestV04.ToDocument() method. The returned TransferInCancellationRequestV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram TransferInCancellationRequestV04Document *-- TransferInCancellationRequestV04 : 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.04">
<TrfInCxlReq>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<Refs>
<!-- References inner content -->
</Refs>
<Cxl>
<!-- Cancellation inner content -->
</Cxl>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
</TrfInCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_EmP8gRgCEeKqWJINzXcn5g"
nextVersions="_bcqfIRXgEeOocOqSQt5Jbw"
previousVersion="_5Eu2kfpbEeCPwaG9zjUPNQ"
name="TransferInCancellationRequestV04"
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">
<messageBuildingBlock
xmi:id="_EmP8ixgCEeKqWJINzXcn5g"
nextVersions="_bcqfIxXgEeOocOqSQt5Jbw"
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="_EmP8jxgCEeKqWJINzXcn5g"
nextVersions="_bcqfJRXgEeOocOqSQt5Jbw"
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="_B1tJ5Rg2EeK-_89we2b-bA"
nextVersions="_bcqfJxXgEeOocOqSQt5Jbw"
name="Cancellation"
definition="Choice between cancellation by reference or by transfer details."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Cxl"
complexType="_Nv8HQRg2EeK-_89we2b-bA" />
<messageBuildingBlock
xmi:id="_EmP8mxgCEeKqWJINzXcn5g"
nextVersions="_bcqfKRXgEeOocOqSQt5Jbw"
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="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.