ModifyLimitV07

camt.011.001.07

Scope The ModifyLimit message is sent by a member to the transaction administrator. It is used to request modifications in the details of one particular, several or all limits set by the member and managed by the transaction administrator. Each ModifyLimit message can alter only one type of limit (current or default). Usage At any time during the operating hours of the system, the member can request modifications in the limits it has set. For example, the reason may be to unlock the payments queue regarding a particular member, or following a risk management decision issued after an exceptional event has occurred. The member will submit a message requesting modifications in one or more of the following criteria:

type of limit (current/default)
identification of the system
identification of the counterparty
value of the limit(s) (default and/or current limit(s))
point in time when the limit becomes effective Based on the criteria received within the ModifyLimit message, the transaction administrator will execute or reject the requested modification. The transaction administrator may send a Receipt message as a reply to the ModifyLimit request. To verify the outcome of the request, the member may submit a GetLimit message with the appropriate search criteria.

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
%% ModifyLimitV07 recursion level 0 with max 0
ModifyLimitV07 *-- "1..1" MessageHeader1 : MessageHeader
ModifyLimitV07 *-- "0..1" LimitStructure3 : LimitDetails
ModifyLimitV07 *-- "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
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageHeader1 members

Member name	Description	Data Type / Multiplicity
MessageIdentification	Point to point reference, as assigned by the sender, to unambiguously identify the message. Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period.	IsoMax35Text - Required 1..1
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Optional 0..1

LimitDetails building block

Identifies one particular limit set by the member and managed by the transaction administrator. Limit details of one particular limit set by the member and managed by the transaction administrator. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% LimitStructure3 recursion level 0 with max 1
LimitStructure3 *-- "1..1" ILimitIdentification2Choice : LimitIdentification
LimitStructure3 *-- "1..1" Limit8 : NewLimitValueSet
%% ILimitIdentification2Choice recursion level 1 with max 1
%% Limit8 recursion level 1 with max 1
class Limit8{
    CreditDebitIndicator CreditDebitCode
}
Limit8 *-- "0..1" IDateAndDateTime2Choice : StartDateTime
Limit8 *-- "1..1" IAmount2Choice : Amount

LimitStructure3 members

Member name	Description	Data Type / Multiplicity
LimitIdentification	Identification of the default limit.	ILimitIdentification2Choice - Required 1..1
NewLimitValueSet	New limit values.	Limit8 - Required 1..1

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

Member name	Description	Data Type / Multiplicity
PlaceAndName	Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath.	IsoMax350Text - Optional 0..1
Envelope	Technical element wrapping the supplementary data.	IsoSupplementaryDataEnvelope1 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ModifyLimitV07 --|> IOuterRecord : Implements
    ModifyLimitV07Document --|> IOuterDocument~ModifyLimitV07~ : Implements
    class IOuterDocument~ModifyLimitV07~ {
        ModifyLimitV07 Message
     }

Document wrapper for serialization

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

classDiagram
    ModifyLimitV07Document *-- ModifyLimitV07 : 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.011.001.07">
    <ModfyLmt>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <LmtDtls>
            <!-- LimitDetails inner content -->
        </LmtDtls>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </ModfyLmt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jwlbvxbvEeiyVv5j1vf1VQ"
  name="ModifyLimitV07"
  definition="Scope&#xA;The ModifyLimit message is sent by a member to the transaction administrator.&#xA;It is used to request modifications in the details of one particular, several or all limits set by the member and managed by the transaction administrator.&#xA;Each ModifyLimit message can alter only one type of limit (current or default).&#xA;Usage&#xA;At any time during the operating hours of the system, the member can request modifications in the limits it has set. For example, the reason may be to unlock the payments queue regarding a particular member, or following a risk management decision issued after an exceptional event has occurred.&#xA;The member will submit a message requesting modifications in one or more of the following criteria: &#xA;- type of limit (current/default)&#xA;- identification of the system&#xA;- identification of the counterparty&#xA;- value of the limit(s) (default and/or current limit(s))&#xA;- point in time when the limit becomes effective&#xA;Based on the criteria received within the ModifyLimit message, the transaction administrator will execute or reject the requested modification. The transaction administrator may send a Receipt message as a reply to the ModifyLimit request. To verify the outcome of the request, the member may submit a GetLimit message with the appropriate search criteria."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="ModfyLmt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_jwlbwRbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
  <messageBuildingBlock
    xmi:id="_jwlbwxbvEeiyVv5j1vf1VQ"
    name="LimitDetails"
    definition="Identifies one particular limit set by the member and managed by the transaction administrator."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="LmtDtls"
    complexType="_A1FWUW4-EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_jwlbxRbvEeiyVv5j1vf1VQ"
    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="011"
    flavour="001"
    version="07" />
</messageDefinition>

ISO Building Blocks

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