ReturnStandingOrderV05

camt.070.001.05

Scope The ReturnStandingOrder message is sent by a transaction administrator to a member. It is used to provide information on the details of one or more standing orders, based on specific request and return criteria. in response to a request a on information on standing and predefined orders. Usage The ReturnStandingOrder message lists the standing order based on the following possible return criteria:

• Generic standing order details,
• Details of a specific predefined or standing liquidity transfer orders,
• Details on the set to which the standing order belongs to,
• List of all predefined and standing liquidity transfer standing orders and/or per set,
• Total amount of predefined and standing liquidity transfer orders defined in the system.

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
%% ReturnStandingOrderV05 recursion level 0 with max 0
ReturnStandingOrderV05 *-- "1..1" MessageHeader6 : MessageHeader
ReturnStandingOrderV05 *-- "1..1" IStandingOrderOrError7Choice : ReportOrError
ReturnStandingOrderV05 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

MessageHeader building block

Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageHeader6 recursion level 0 with max 1
class MessageHeader6{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    QueryName IsoMax35Text
}
MessageHeader6 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
MessageHeader6 *-- "0..1" IRequestType3Choice : RequestType
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
%% IRequestType3Choice recursion level 1 with max 1
  

MessageHeader6 members

ReportOrError building block

Reports on standing orders. Choice between the standing order details or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification

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

StandingOrderOrError7Choice members

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
  

SupplementaryData1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ReturnStandingOrderV05 --|> IOuterRecord : Implements
    ReturnStandingOrderV05Document --|> IOuterDocument~ReturnStandingOrderV05~ : Implements
    class IOuterDocument~ReturnStandingOrderV05~ {
        ReturnStandingOrderV05 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ReturnStandingOrderV05Document *-- ReturnStandingOrderV05 : 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:camt.070.001.05">
    <RtrStgOrdr>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <RptOrErr>
            <!-- ReportOrError inner content -->
        </RptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </RtrStgOrdr>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ThWhvdb6Eeq_l4BJLVUF2Q"
  previousVersion="_jwlcMRbvEeiyVv5j1vf1VQ"
  name="ReturnStandingOrderV05"
  definition="Scope&#xA;The ReturnStandingOrder message is sent by a transaction administrator to a member.&#xA;It is used to provide information on the details of one or more standing orders, based on specific request and return criteria.&#xA;in response to a request a on information on standing and predefined orders.&#xA;Usage&#xA;The ReturnStandingOrder message lists the standing order based on the following possible return criteria: &#xA;- Generic standing order details,&#xA;- Details of a specific predefined or standing liquidity transfer orders,&#xA;- Details on the set to which the standing order belongs to,&#xA;- List of all predefined and standing liquidity transfer standing orders and/or per set,&#xA;- Total amount of predefined and standing liquidity transfer orders defined in the system."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="RtrStgOrdr"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ThWhxdb6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcMxbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_76joZ6MgEeCJ6YNENx4h-w_1740600575" />
  <messageBuildingBlock
    xmi:id="_ThWhx9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcNRbvEeiyVv5j1vf1VQ"
    name="ReportOrError"
    definition="Reports on standing orders."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptOrErr"
    complexType="_eZL10dcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_ThWhydb6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcNxbvEeiyVv5j1vf1VQ"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="070"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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