GetStandingOrderV04

camt.069.001.04

Scope The GetStandingOrder message is sent by a member to the transaction administrator. It is used to request information on the details of one or more standing orders, based on specific request criteria, especially to query the amount of the overall liquidity available. It will allow to query both reserved liquidity and liquidity available for normal operations. Usage The member can request information based on the following elements:

• individual standing orders (predefined or standing liquidity transfer orders)
• amount
• account to be credited
• account to be debited
• account owner (for on behalf scenario)
• frequency of payment
• daytime or overnight processing
• dates when the standing order begins and ceases to be effective This message will be answered by a ReturnStandingOrder message.

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
%% GetStandingOrderV04 recursion level 0 with max 0
GetStandingOrderV04 *-- "1..1" MessageHeader4 : MessageHeader
GetStandingOrderV04 *-- "0..1" StandingOrderQuery4 : StandingOrderQueryDefinition
GetStandingOrderV04 *-- "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
%% MessageHeader4 recursion level 0 with max 1
class MessageHeader4{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader4 *-- "0..1" IRequestType3Choice : RequestType
%% IRequestType3Choice recursion level 1 with max 1
  

MessageHeader4 members

StandingOrderQueryDefinition building block

Defines the account query criteria. Specification of the query criteria. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StandingOrderQuery4 recursion level 0 with max 1
class StandingOrderQuery4{
    QueryType QueryType2Code
}
StandingOrderQuery4 *-- "0..1" IStandingOrderCriteria4Choice : StandingOrderCriteria
%% IStandingOrderCriteria4Choice recursion level 1 with max 1
  

StandingOrderQuery4 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 GetStandingOrderV04 implementation follows a specific implementaiton pattern. First of all, GetStandingOrderV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetStandingOrderV04Document implements IOuterDocument. Because GetStandingOrderV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetStandingOrderV04.

classDiagram
    class IOuterRecord
    GetStandingOrderV04 --|> IOuterRecord : Implements
    GetStandingOrderV04Document --|> IOuterDocument~GetStandingOrderV04~ : Implements
    class IOuterDocument~GetStandingOrderV04~ {
        GetStandingOrderV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    GetStandingOrderV04Document *-- GetStandingOrderV04 : 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.069.001.04">
    <GetStgOrdr>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <StgOrdrQryDef>
            <!-- StandingOrderQueryDefinition inner content -->
        </StgOrdrQryDef>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </GetStgOrdr>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ThPM8db6Eeq_l4BJLVUF2Q"
  previousVersion="_jwlbnxbvEeiyVv5j1vf1VQ"
  name="GetStandingOrderV04"
  definition="Scope&#xA;The GetStandingOrder message is sent by a member to the transaction administrator.&#xA;It is used to request information on the details of one or more standing orders, based on specific request criteria, especially to query the amount of the overall liquidity available. It will allow to query both reserved liquidity and liquidity available for normal operations.&#xA;Usage&#xA;The member can request information based on the following elements: &#xA;- individual standing orders (predefined or standing liquidity transfer orders)&#xA;- amount&#xA;- account to be credited&#xA;- account to be debited&#xA;- account owner (for on behalf scenario)&#xA;- frequency of payment&#xA;- daytime or overnight processing&#xA;- dates when the standing order begins and ceases to be effective&#xA;This message will be answered by a ReturnStandingOrder message."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="GetStgOrdr"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ThPM99b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlboRbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_77AUVKMgEeCJ6YNENx4h-w_1376931885" />
  <messageBuildingBlock
    xmi:id="_ThPM-db6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlboxbvEeiyVv5j1vf1VQ"
    name="StandingOrderQueryDefinition"
    definition="Defines the account query criteria."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="StgOrdrQryDef"
    complexType="_gawsAdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_ThPM-9b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlbpRbvEeiyVv5j1vf1VQ"
    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="069"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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