PortfolioTransferCancellationRequestV04

sese.014.001.04

Scope An instructing party, for example, a (new) plan manager (Transferee), sends the PortfolioTransferCancellationRequest message to the executing party, for example, a (old) plan manager (Transferor), to request the cancellation of a previously sent PortfolioTransferInstruction. Usage The PortfolioTransferCancellationRequest message is used to request the cancellation of an entire PortfolioTransferInstruction message, ie, all the product transfers that it contained. The cancellation request can be specified either by:

• quoting the transfer references of all the product transfers listed in the PortfolioTransferInstruction message, or,
• quoting the details of all the product transfers (this includes TransferReference) listed in PortfolioTransferInstruction message. The message identification of the PortfolioTransferInstruction may also be quoted in PreviousReference. It is also possible to request the cancellation of PortfolioTransferInstruction by just 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
%% PortfolioTransferCancellationRequestV04 recursion level 0 with max 0
PortfolioTransferCancellationRequestV04 *-- "1..1" MessageIdentification1 : MessageReference
PortfolioTransferCancellationRequestV04 *-- "0..1" AdditionalReference3 : PoolReference
PortfolioTransferCancellationRequestV04 *-- "0..1" AdditionalReference3 : PreviousReference
PortfolioTransferCancellationRequestV04 *-- "0..1" AdditionalReference3 : RelatedReference
PortfolioTransferCancellationRequestV04 *-- "1..1" ICancellation3Choice : Cancellation
  

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

MessageReference building block

Identifies the message. 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

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
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

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
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 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
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

Cancellation building block

Choice between cancellation by transfer details or reference. Choice between cancellation by transfer details or reference. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ICancellation3Choice recursion level 0 with max 1
  

Cancellation3Choice members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PortfolioTransferCancellationRequestV04 --|> IOuterRecord : Implements
    PortfolioTransferCancellationRequestV04Document --|> IOuterDocument~PortfolioTransferCancellationRequestV04~ : Implements
    class IOuterDocument~PortfolioTransferCancellationRequestV04~ {
        PortfolioTransferCancellationRequestV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PortfolioTransferCancellationRequestV04Document *-- PortfolioTransferCancellationRequestV04 : 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.014.001.04">
    <PrtflTrfCxlReq>
        <MsgRef>
            <!-- MessageReference inner content -->
        </MsgRef>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <Cxl>
            <!-- Cancellation inner content -->
        </Cxl>
    </PrtflTrfCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_gvWxsRgBEeKqWJINzXcn5g"
  nextVersions="_SElK4RXfEeOocOqSQt5Jbw"
  previousVersion="_N35jgfpcEeCPwaG9zjUPNQ"
  name="PortfolioTransferCancellationRequestV04"
  definition="Scope&#xD;&#xA;An instructing party, for example, a (new) plan manager (Transferee), sends the PortfolioTransferCancellationRequest message to the executing party, for example, a (old) plan manager (Transferor), to request the cancellation of a previously sent PortfolioTransferInstruction.&#xD;&#xA;Usage&#xD;&#xA;The PortfolioTransferCancellationRequest message is used to request the cancellation of an entire PortfolioTransferInstruction message, ie, all the product transfers that it contained. The cancellation request can be specified either by:&#xD;&#xA;- quoting the transfer references of all the product transfers listed in the PortfolioTransferInstruction message, or,&#xD;&#xA;- quoting the details of all the product transfers (this includes TransferReference) listed in PortfolioTransferInstruction message.&#xD;&#xA;The message identification of the PortfolioTransferInstruction may also be quoted in PreviousReference. It is also possible to request the cancellation of PortfolioTransferInstruction by just quoting its message identification in PreviousReference."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="PrtflTrfCxlReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_gvWxuxgBEeKqWJINzXcn5g"
    nextVersions="_SElK4xXfEeOocOqSQt5Jbw"
    name="MessageReference"
    definition="Identifies the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_gvWxvxgBEeKqWJINzXcn5g"
    nextVersions="_SElK5RXfEeOocOqSQt5Jbw"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_gvWxwxgBEeKqWJINzXcn5g"
    nextVersions="_SElK5xXfEeOocOqSQt5Jbw"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_gvWxxxgBEeKqWJINzXcn5g"
    nextVersions="_SElK6RXfEeOocOqSQt5Jbw"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_nfmISyccEeK33eWt3gq4Fg"
    nextVersions="_SElK6xXfEeOocOqSQt5Jbw"
    name="Cancellation"
    definition="Choice between cancellation by transfer details or reference."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Cxl"
    complexType="_uMEusycZEeK33eWt3gq4Fg" />
  <messageDefinitionIdentifier
    businessArea="sese"
    messageFunctionality="014"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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