PortfolioTransferCancellationRequestV03

sese.014.001.03

Scope An instructing party, eg, a (new) plan manager (Transferee), sends the PortfolioTransferCancellationRequest message to the executing party, eg, 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
%% PortfolioTransferCancellationRequestV03 recursion level 0 with max 0
PortfolioTransferCancellationRequestV03 *-- "1..1" MessageIdentification1 : MessageReference
PortfolioTransferCancellationRequestV03 *-- "0..1" AdditionalReference3 : PoolReference
PortfolioTransferCancellationRequestV03 *-- "0..1" AdditionalReference3 : PreviousReference
PortfolioTransferCancellationRequestV03 *-- "0..1" AdditionalReference3 : RelatedReference
PortfolioTransferCancellationRequestV03 *-- "0..1" PEPISATransfer11 : CancellationByTransferInstructionDetails
PortfolioTransferCancellationRequestV03 *-- "0..1" TransferReference3 : CancellationByReference
  

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

CancellationByTransferInstructionDetails building block

Information related to the transfer instruction to be cancelled. Information about a transfer instruction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PEPISATransfer11 recursion level 0 with max 1
PEPISATransfer11 *-- "0..1" IndividualPerson8 : PrimaryIndividualInvestor
PEPISATransfer11 *-- "0..1" IndividualPerson8 : SecondaryIndividualInvestor
PEPISATransfer11 *-- "0..0" IndividualPerson8 : OtherIndividualInvestor
PEPISATransfer11 *-- "0..1" Organisation4 : PrimaryCorporateInvestor
PEPISATransfer11 *-- "0..1" Organisation4 : SecondaryCorporateInvestor
PEPISATransfer11 *-- "0..0" Organisation4 : OtherCorporateInvestor
PEPISATransfer11 *-- "1..1" Account5 : TransferorAccount
PEPISATransfer11 *-- "0..1" Account6 : NomineeAccount
PEPISATransfer11 *-- "1..1" IPartyIdentification2Choice : Transferee
PEPISATransfer11 *-- "0..1" CashAccount11 : CashAccount
PEPISATransfer11 *-- "1..0" ISATransfer3 : ProductTransfer
PEPISATransfer11 *-- "0..0" Extension1 : Extension
%% IndividualPerson8 recursion level 1 with max 1
class IndividualPerson8{
    Name IsoMax35Text
    GivenName IsoMax35Text
    NamePrefix NamePrefix1Code
    NameSuffix IsoMax35Text
    Gender GenderCode
    BirthDate IsoISODate
    SocialSecurityNumber IsoMax35Text
}
IndividualPerson8 *-- "1..1" PostalAddress1 : IndividualInvestorAddress
%% IndividualPerson8 recursion level 1 with max 1
class IndividualPerson8{
    Name IsoMax35Text
    GivenName IsoMax35Text
    NamePrefix NamePrefix1Code
    NameSuffix IsoMax35Text
    Gender GenderCode
    BirthDate IsoISODate
    SocialSecurityNumber IsoMax35Text
}
IndividualPerson8 *-- "1..1" PostalAddress1 : IndividualInvestorAddress
%% IndividualPerson8 recursion level 1 with max 1
class IndividualPerson8{
    Name IsoMax35Text
    GivenName IsoMax35Text
    NamePrefix NamePrefix1Code
    NameSuffix IsoMax35Text
    Gender GenderCode
    BirthDate IsoISODate
    SocialSecurityNumber IsoMax35Text
}
IndividualPerson8 *-- "1..1" PostalAddress1 : IndividualInvestorAddress
%% Organisation4 recursion level 1 with max 1
class Organisation4{
    Name IsoMax140Text
    Purpose IsoMax35Text
    TaxationCountry CountryCode
    RegistrationCountry CountryCode
    RegistrationDate IsoISODate
    TaxIdentificationNumber IsoMax35Text
    NationalRegistrationNumber IsoMax35Text
}
Organisation4 *-- "0..1" IPartyIdentification4Choice : Identification
Organisation4 *-- "1..1" PostalAddress1 : CorporateInvestorAddress
%% Organisation4 recursion level 1 with max 1
class Organisation4{
    Name IsoMax140Text
    Purpose IsoMax35Text
    TaxationCountry CountryCode
    RegistrationCountry CountryCode
    RegistrationDate IsoISODate
    TaxIdentificationNumber IsoMax35Text
    NationalRegistrationNumber IsoMax35Text
}
Organisation4 *-- "0..1" IPartyIdentification4Choice : Identification
Organisation4 *-- "1..1" PostalAddress1 : CorporateInvestorAddress
%% Organisation4 recursion level 1 with max 1
class Organisation4{
    Name IsoMax140Text
    Purpose IsoMax35Text
    TaxationCountry CountryCode
    RegistrationCountry CountryCode
    RegistrationDate IsoISODate
    TaxIdentificationNumber IsoMax35Text
    NationalRegistrationNumber IsoMax35Text
}
Organisation4 *-- "0..1" IPartyIdentification4Choice : Identification
Organisation4 *-- "1..1" PostalAddress1 : CorporateInvestorAddress
%% Account5 recursion level 1 with max 1
class Account5{
    Identification IsoMax35Text
    Designation IsoMax35Text
}
Account5 *-- "1..1" IPartyIdentification2Choice : Servicer
%% Account6 recursion level 1 with max 1
class Account6{
    Identification IsoMax35Text
    Designation IsoMax35Text
}
Account6 *-- "0..1" IPartyIdentification2Choice : Servicer
%% IPartyIdentification2Choice recursion level 1 with max 1
%% CashAccount11 recursion level 1 with max 1
CashAccount11 *-- "1..1" ICashAccountIdentification1Choice : Identification
CashAccount11 *-- "0..1" IFinancialInstitutionIdentification3Choice : AccountServicer
%% ISATransfer3 recursion level 1 with max 1
class ISATransfer3{
    MasterReference IsoMax35Text
    TransferIdentification IsoMax35Text
    CancellationReference IsoMax35Text
    ResidualCash ResidualCash1Code
    AllOtherCash IsoYesNoIndicator
}
ISATransfer3 *-- "1..1" IISAPortfolio1Choice : Portfolio
ISATransfer3 *-- "0..0" FinancialInstrument25 : FinancialInstrumentAssetForTransfer
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

PEPISATransfer11 members

CancellationByReference building block

Reference of the transfer instruction to be cancelled. Reference of a transfer instruction cancellation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransferReference3 recursion level 0 with max 1
class TransferReference3{
    MasterReference IsoMax35Text
}
TransferReference3 *-- "1..0" TransferReference4 : TransferReferences
%% TransferReference4 recursion level 1 with max 1
class TransferReference4{
    TransferReference IsoMax35Text
    CancellationReference IsoMax35Text
}
  

TransferReference3 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PortfolioTransferCancellationRequestV03 --|> IOuterRecord : Implements
    PortfolioTransferCancellationRequestV03Document --|> IOuterDocument~PortfolioTransferCancellationRequestV03~ : Implements
    class IOuterDocument~PortfolioTransferCancellationRequestV03~ {
        PortfolioTransferCancellationRequestV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PortfolioTransferCancellationRequestV03Document *-- PortfolioTransferCancellationRequestV03 : 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.03">
    <PrtflTrfCxlReq>
        <MsgRef>
            <!-- MessageReference inner content -->
        </MsgRef>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <CxlByTrfInstrDtls>
            <!-- CancellationByTransferInstructionDetails inner content -->
        </CxlByTrfInstrDtls>
        <CxlByRef>
            <!-- CancellationByReference inner content -->
        </CxlByRef>
    </PrtflTrfCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_N35jgfpcEeCPwaG9zjUPNQ"
  nextVersions="_gvWxsRgBEeKqWJINzXcn5g"
  previousVersion="_j9ueC9E5Ed-BzquC8wXy7w_493377092"
  name="PortfolioTransferCancellationRequestV03"
  definition="Scope&#xD;&#xA;An instructing party, eg, a (new) plan manager (Transferee), sends the PortfolioTransferCancellationRequest message to the executing party, eg, 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">
  <xors
    xmi:id="_N35jhfpcEeCPwaG9zjUPNQ"
    name="Operation1"
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_N35jnfpcEeCPwaG9zjUPNQ _N35jofpcEeCPwaG9zjUPNQ" />
  <messageBuildingBlock
    xmi:id="_N35jjfpcEeCPwaG9zjUPNQ"
    name="MessageReference"
    definition="Identifies the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_N35jkfpcEeCPwaG9zjUPNQ"
    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="_N35jlfpcEeCPwaG9zjUPNQ"
    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="_N35jmfpcEeCPwaG9zjUPNQ"
    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="_N35jnfpcEeCPwaG9zjUPNQ"
    name="CancellationByTransferInstructionDetails"
    definition="Information related to the transfer instruction to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByTrfInstrDtls"
    complexType="_XE7zcfpfEeCLMa5EIHtDrg" />
  <messageBuildingBlock
    xmi:id="_N35jofpcEeCPwaG9zjUPNQ"
    name="CancellationByReference"
    definition="Reference of the transfer instruction to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByRef"
    complexType="_SwnEetp-Ed-ak6NoX_4Aeg_63934446" />
  <messageDefinitionIdentifier
    businessArea="sese"
    messageFunctionality="014"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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