TransferInstructionStatusReport

sese.011.001.01

Scope The TransferInstructionStatusReport message is sent by an instructing party to the executing party. The instructing party may be an investor, a transfer agent, or an intermediary, etc. The executing party may be a transfer agent, or an intermediary, etc. This message gives the status of a transfer instruction, and can be used from the time the executing party receives the transfer instruction until its execution. Usage The TransferInstructionStatusReport message is sent by an executing party to the instructing party. The message can be used to report one of the following

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
%% TransferInstructionStatusReport recursion level 0 with max 0
TransferInstructionStatusReport *-- "1..1" AdditionalReference2 : RelatedReference
TransferInstructionStatusReport *-- "1..1" AdditionalReference2 : OtherReference
TransferInstructionStatusReport *-- "1..1" TransferStatusAndReason : 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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification1Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

OtherReference building block

Reference to a 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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification1Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

StatusReport building block

Status of the transfer instruction. Information about the status of a transfer instruction and its reason. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransferStatusAndReason recursion level 0 with max 1
class TransferStatusAndReason{
    TransferReference IsoMax35Text
}
TransferStatusAndReason *-- "1..1" TransferInstructionStatus : Status
TransferStatusAndReason *-- "1..1" IPendingSettlementStatusChoice : PendingSettlement
TransferStatusAndReason *-- "1..1" TransferUnmatchedStatus : Unmatched
TransferStatusAndReason *-- "1..1" IInRepairStatus2Choice : InRepair
TransferStatusAndReason *-- "1..1" IRejectedStatus3Choice : Rejected
TransferStatusAndReason *-- "0..1" IPartyIdentification1Choice : StatusInitiator
%% TransferInstructionStatus recursion level 1 with max 1
class TransferInstructionStatus{
    Status TransferStatus1Code
    AdditionalInformation IsoMax350Text
}
%% IPendingSettlementStatusChoice recursion level 1 with max 1
%% TransferUnmatchedStatus recursion level 1 with max 1
class TransferUnmatchedStatus{
    NoReason NoReasonCode
}
TransferUnmatchedStatus *-- "1..1" TransferUnmatchedStatusReason1 : Reason
TransferUnmatchedStatus *-- "1..1" GenericIdentification1 : DataSourceScheme
%% IInRepairStatus2Choice recursion level 1 with max 1
%% IRejectedStatus3Choice recursion level 1 with max 1
%% IPartyIdentification1Choice recursion level 1 with max 1
  

TransferStatusAndReason members

Member name Description Data Type / Multiplicity
TransferReference Business reference of the transfer instruction. IsoMax35Text - Required 1..1
Status Instruction status and the reason for the status. TransferInstructionStatus - Required 1..1
PendingSettlement Status of the transfer instruction is pending settlement. IPendingSettlementStatusChoice - Required 1..1
Unmatched Status of the transfer instruction is unmatched. TransferUnmatchedStatus - Required 1..1
InRepair Status is in repair. IInRepairStatus2Choice - Required 1..1
Rejected Status of the transfer instructed is rejected. IRejectedStatus3Choice - Required 1..1
StatusInitiator Party that initiates the status. IPartyIdentification1Choice - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    TransferInstructionStatusReport --|> IOuterRecord : Implements
    TransferInstructionStatusReportDocument --|> IOuterDocument~TransferInstructionStatusReport~ : Implements
    class IOuterDocument~TransferInstructionStatusReport~ {
        TransferInstructionStatusReport Message
     }
  

Document wrapper for serialization

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

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

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_K0uj29E6Ed-BzquC8wXy7w_569643185"
  nextVersions="_K1BewNE6Ed-BzquC8wXy7w_1077069580"
  name="TransferInstructionStatusReport"
  definition="Scope&#xD;&#xA;The TransferInstructionStatusReport message is sent by an instructing party to the executing party. The instructing party may be an investor, a transfer agent, or an intermediary, etc. The executing party may be a transfer agent, or an intermediary, etc.&#xD;&#xA;This message gives the status of a transfer instruction, and can be used from the time the executing party receives the transfer instruction until its execution.&#xD;&#xA;Usage&#xD;&#xA;The TransferInstructionStatusReport message is sent by an executing party to the instructing party. The message can be used to report one of the following&#xD;&#xA;- the status of the transfer instruction (using a code)or&#xD;&#xA;- the repair status or&#xD;&#xA;- the unmatched status or&#xD;&#xA;- the rejection status or&#xD;&#xA;- the pending settlement status.&#xD;&#xA;Further information about repair, unmatched, rejected or pending settlement statuses must be specified using either codes or unstructured information."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="sese.011.001.01"
  xmlTag="sese.011.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <xors
    xmi:id="_K04U0tE6Ed-BzquC8wXy7w_828227220"
    name="RelatedReferenceOrOtherReferenceRule"
    definition="If OtherReference is present, then RelatedReference is not allowed. If OtherReference is not present, then RelatedReference is mandatory."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_K0uj3NE6Ed-BzquC8wXy7w_902110432 _K04U0NE6Ed-BzquC8wXy7w_900264708" />
  <messageBuildingBlock
    xmi:id="_K0uj3NE6Ed-BzquC8wXy7w_902110432"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RltdRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_K04U0NE6Ed-BzquC8wXy7w_900264708"
    name="OtherReference"
    definition="Reference to a 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="_K04U0dE6Ed-BzquC8wXy7w_2104535600"
    name="StatusReport"
    definition="Status of the transfer instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_UzmP6dp-Ed-ak6NoX_4Aeg_-2005620583" />
  <messageDefinitionIdentifier
    businessArea="sese"
    messageFunctionality="011"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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