TransferOutCancellationInstruction

sese.002.001.01

Scope The TransferOutCancellationInstruction message is sent by an instructing party or an instructing party’s designated agent to the executing party. This message is used to request the cancellation of a TransferOutInstruction that was previously sent by the instructing party. Usage The TransferOutCancellationInstruction message is sent by an instructing party to request cancellation of a previously sent TransferOutInstruction. This message must contain the reference of the message to be cancelled. The message may also contain all the details of the message to be cancelled, but this is not recommended.

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
%% TransferOutCancellationInstruction recursion level 0 with max 0
TransferOutCancellationInstruction *-- "1..1" AdditionalReference2 : PreviousReference
TransferOutCancellationInstruction *-- "0..1" AdditionalReference2 : PoolReference
TransferOutCancellationInstruction *-- "0..1" AdditionalReference2 : RelatedReference
TransferOutCancellationInstruction *-- "0..1" TransferOut2 : TransferOutToBeCancelled
  

Now, we will zero-in one-by-one on each of these building blocks.

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

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

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

TransferOutToBeCancelled building block

Information about a transfer out transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransferOut2 recursion level 0 with max 1
TransferOut2 *-- "1..1" Transfer1 : TransferDetails
TransferOut2 *-- "1..1" FinancialInstrument3 : FinancialInstrumentDetails
TransferOut2 *-- "1..1" InvestmentAccount10 : AccountDetails
TransferOut2 *-- "1..1" ReceiveInformation1 : SettlementDetails
TransferOut2 *-- "0..0" Extension1 : Extension
%% Transfer1 recursion level 1 with max 1
class Transfer1{
    TransferReference IsoMax35Text
    PortfolioTransferOutRate IsoPercentageRate
    OwnAccountTransferIndicator IsoYesNoIndicator
    AveragePrice IsoActiveOrHistoricCurrencyAnd13DecimalAmount
}
Transfer1 *-- "1..1" IDateFormat1Choice : RequestedTransferDate
Transfer1 *-- "1..1" FinancialInstrumentQuantity1 : TotalUnitsNumber
Transfer1 *-- "0..0" Unit1 : UnitsDetails
%% FinancialInstrument3 recursion level 1 with max 1
class FinancialInstrument3{
    Name IsoMax350Text
    SupplementaryIdentification IsoMax35Text
    RequestedNAVCurrency ActiveOrHistoricCurrencyCode
    ClassType IsoMax35Text
    SecuritiesForm FormOfSecurity1Code
    DistributionPolicy DistributionPolicy1Code
}
FinancialInstrument3 *-- "1..1" ISecurityIdentification1Choice : Identification
%% InvestmentAccount10 recursion level 1 with max 1
class InvestmentAccount10{
    AccountName IsoMax35Text
    AccountDesignation IsoMax35Text
    SecuritiesForm FormOfSecurity1Code
    DematerialisedIndicator IsoYesNoIndicator
    IncomePreference IncomePreference1Code
    BeneficiaryCertificationIndicator IsoYesNoIndicator
}
InvestmentAccount10 *-- "0..0" IPartyIdentification1Choice : OwnerIdentification
InvestmentAccount10 *-- "1..1" AccountIdentification1 : AccountIdentification
InvestmentAccount10 *-- "0..0" Intermediary1 : IntermediaryInformation
InvestmentAccount10 *-- "0..1" IPartyIdentification1Choice : SafekeepingPlace
InvestmentAccount10 *-- "0..1" IPartyIdentification1Choice : AccountServicer
%% ReceiveInformation1 recursion level 1 with max 1
class ReceiveInformation1{
    PhysicalTransferIndicator IsoYesNoIndicator
}
ReceiveInformation1 *-- "1..1" ReceivingPartiesAndAccount1 : SettlementPartiesDetails
ReceiveInformation1 *-- "0..1" DeliveryParameters2 : PhysicalTransferDetails
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

TransferOut2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransferOutCancellationInstruction --|> IOuterRecord : Implements
    TransferOutCancellationInstructionDocument --|> IOuterDocument~TransferOutCancellationInstruction~ : Implements
    class IOuterDocument~TransferOutCancellationInstruction~ {
        TransferOutCancellationInstruction Message
     }
  

Document wrapper for serialization

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

classDiagram
    TransferOutCancellationInstructionDocument *-- TransferOutCancellationInstruction : 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.002.001.01">
    <sese.002.001.01>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <TrfOutToBeCanc>
            <!-- TransferOutToBeCancelled inner content -->
        </TrfOutToBeCanc>
    </sese.002.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_K1LPztE6Ed-BzquC8wXy7w_-1400319754"
  nextVersions="_K1UZvtE6Ed-BzquC8wXy7w_-1994475109"
  name="TransferOutCancellationInstruction"
  definition="Scope&#xD;&#xA;The TransferOutCancellationInstruction message is sent by an instructing party or an instructing party's designated agent to the executing party.&#xD;&#xA;This message is used to request the cancellation of a TransferOutInstruction that was previously sent by the instructing party.&#xD;&#xA;Usage&#xD;&#xA;The TransferOutCancellationInstruction message is sent by an instructing party to request cancellation of a previously sent TransferOutInstruction.&#xD;&#xA;This message must contain the reference of the message to be cancelled. The message may also contain all the details of the message to be cancelled, but this is not recommended."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="sese.002.001.01"
  xmlTag="sese.002.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_K1LPz9E6Ed-BzquC8wXy7w_1122541530"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrvsRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_K1LP0NE6Ed-BzquC8wXy7w_-627107887"
    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="_K1UZsNE6Ed-BzquC8wXy7w_-615102237"
    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="_K1UZsdE6Ed-BzquC8wXy7w_-1481678373"
    name="TransferOutToBeCancelled"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="TrfOutToBeCanc"
    complexType="_U07sptp-Ed-ak6NoX_4Aeg_1855595755" />
  <messageDefinitionIdentifier
    businessArea="sese"
    messageFunctionality="002"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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