TransferCancellationStatusReport

sese.010.001.01

Scope The TransferCancellationStatusReport message is sent by an executing party to the instructing party. The message gives the status of a transfer cancellation instruction that was previously sent by the instructing party. Usage The TransferCancellationStatusReport message is sent by an executing party to the instructing party. The message can be used to report that either

• the cancellation has been acted upon or
• the cancellation is rejected. In both cases, the reason must be specified using either a code or unstructured information.

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
%% TransferCancellationStatusReport recursion level 0 with max 0
TransferCancellationStatusReport *-- "1..2" AdditionalReference2 : RelatedReference
TransferCancellationStatusReport *-- "1..1" AdditionalReference2 : OtherReference
TransferCancellationStatusReport *-- "1..1" CancellationStatusAndReason : StatusReport
  

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

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

OtherReference building block

Reference to the linked message sent in a proprietary way or the reference of a system. 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

StatusReport building block

Status of the transfer cancellation instruction. Status of a transfer cancellation instruction and the reason for the status. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CancellationStatusAndReason recursion level 0 with max 1
CancellationStatusAndReason *-- "1..1" TransferCancellationStatus : Status
CancellationStatusAndReason *-- "1..1" ITransferCancellationRejectedStatus1Choice : Rejected
CancellationStatusAndReason *-- "1..1" ITransferCancellationCompleteStatusChoice : Complete
CancellationStatusAndReason *-- "0..1" IPartyIdentification1Choice : StatusInitiator
%% TransferCancellationStatus recursion level 1 with max 1
class TransferCancellationStatus{
    Status CancellationStatus1Code
    AdditionalInformation IsoMax350Text
}
%% ITransferCancellationRejectedStatus1Choice recursion level 1 with max 1
%% ITransferCancellationCompleteStatusChoice recursion level 1 with max 1
%% IPartyIdentification1Choice recursion level 1 with max 1
  

CancellationStatusAndReason members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransferCancellationStatusReport --|> IOuterRecord : Implements
    TransferCancellationStatusReportDocument --|> IOuterDocument~TransferCancellationStatusReport~ : Implements
    class IOuterDocument~TransferCancellationStatusReport~ {
        TransferCancellationStatusReport Message
     }
  

Document wrapper for serialization

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

classDiagram
    TransferCancellationStatusReportDocument *-- TransferCancellationStatusReport : 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.010.001.01">
    <sese.010.001.01>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <OthrRef>
            <!-- OtherReference inner content -->
        </OthrRef>
        <StsRpt>
            <!-- StatusReport inner content -->
        </StsRpt>
    </sese.010.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_HFtUYNE6Ed-BzquC8wXy7w_1729523466"
  nextVersions="_HnZFINE6Ed-BzquC8wXy7w_1645958483"
  name="TransferCancellationStatusReport"
  definition="Scope&#xD;&#xA;The TransferCancellationStatusReport message is sent by an executing party to the instructing party.&#xD;&#xA;The message gives the status of a transfer cancellation instruction that was previously sent by the instructing party.&#xD;&#xA;Usage&#xD;&#xA;The TransferCancellationStatusReport message is sent by an executing party to the instructing party. The message can be used to report that either&#xD;&#xA;- the cancellation has been acted upon or&#xD;&#xA;- the cancellation is rejected.&#xD;&#xA;In both cases, the reason must be specified using either a code or unstructured information."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="sese.010.001.01"
  xmlTag="sese.010.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <xors
    xmi:id="_HFtUZNE6Ed-BzquC8wXy7w_999346904"
    name="RelatedReferenceOrOtherReferenceRule"
    definition="If OtherReference is not present, then RelatedReference is mandatory. If OtherReference is present, then RelatedReference is not allowed."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_HFtUYdE6Ed-BzquC8wXy7w_1157267444 _HFtUYtE6Ed-BzquC8wXy7w_1159114780" />
  <messageBuildingBlock
    xmi:id="_HFtUYdE6Ed-BzquC8wXy7w_1157267444"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="1"
    xmlTag="RltdRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_HFtUYtE6Ed-BzquC8wXy7w_1159114780"
    name="OtherReference"
    definition="Reference to the linked message sent in a proprietary way or the reference of a system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="OthrRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_HFtUY9E6Ed-BzquC8wXy7w_-503487552"
    name="StatusReport"
    definition="Status of the transfer cancellation instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_Uww-Vtp-Ed-ak6NoX_4Aeg_-973620019" />
  <messageDefinitionIdentifier
    businessArea="sese"
    messageFunctionality="010"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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