camt.010.001.08
Scope The ReturnLimit message is sent by the transaction administrator to a member of the system. It is used to provide information on the details of one or more limits set by the member (or on behalf of the member) and managed by the transaction administrator. The ReturnLimit message can be sent as a response to a related GetLimit message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred. Usage At any time during the operating hours of the system, the member can query the transaction administrator to get information about the limit(s) that the transaction administrator manages for the member. The transaction administrator may also send a ReturnLimit message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs attention. The message from the transaction administrator can contain information on the following elements:
- type of risk and/or liquidity limit
- value of the limit(s) (default and/or current limit(s) for risk and/or liquidity management)
- identification of the system
- status of the limit(s) (default and/or current limit(s) for risk and/or liquidity management)
- point in time when the limit becomes effective
- identification of the counterparty Additional information on the generic design of the Get/Return messages can be found in the section How to Use the Cash Management Messages.
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
%% ReturnLimitV08 recursion level 0 with max 0
ReturnLimitV08 *-- "1..1" MessageHeader7 : MessageHeader
ReturnLimitV08 *-- "1..1" ILimitReportOrError4Choice : ReportOrError
ReturnLimitV08 *-- "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
%% MessageHeader7 recursion level 0 with max 1
class MessageHeader7{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType4Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader7 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. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
| RequestType | Specific actions to be executed through the request. | IRequestType4Choice - Optional 0..1 |
| OriginalBusinessQuery | Unique identification of the original query message. | OriginalBusinessQuery1 - Optional 0..1 |
| QueryName | Recalls the criteria (search and return criteria) defined in a preceding query. | IsoMax35Text - Optional 0..1 |
ReportOrError building block
Reports on limits. Choice between details of one or more limits set by the member (or on behalf of the member) and managed by the transaction administrator or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ILimitReportOrError4Choice recursion level 0 with max 1
LimitReportOrError4Choice members
| Member name | Description | Data Type / Multiplicity |
|---|
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 ReturnLimitV08 implementation follows a specific implementaiton pattern. First of all, ReturnLimitV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReturnLimitV08Document implements IOuterDocument. Because ReturnLimitV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReturnLimitV08.
classDiagram
class IOuterRecord
ReturnLimitV08 --|> IOuterRecord : Implements
ReturnLimitV08Document --|> IOuterDocument~ReturnLimitV08~ : Implements
class IOuterDocument~ReturnLimitV08~ {
ReturnLimitV08 Message
}
Document wrapper for serialization
The only real purpose ReturnLimitV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.010.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReturnLimitV08.ToDocument() method. The returned ReturnLimitV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ReturnLimitV08Document *-- ReturnLimitV08 : 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.010.001.08">
<RtrLmt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RtrLmt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlcGRbvEeiyVv5j1vf1VQ"
name="ReturnLimitV08"
definition="Scope
The ReturnLimit message is sent by the transaction administrator to a member of the system.
It is used to provide information on the details of one or more limits set by the member (or on behalf of the member) and managed by the transaction administrator.
The ReturnLimit message can be sent as a response to a related GetLimit message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred.
Usage
At any time during the operating hours of the system, the member can query the transaction administrator to get information about the limit(s) that the transaction administrator manages for the member.
The transaction administrator may also send a ReturnLimit message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs attention.
The message from the transaction administrator can contain information on the following elements:
- type of risk and/or liquidity limit
- value of the limit(s) (default and/or current limit(s) for risk and/or liquidity management)
- identification of the system
- status of the limit(s) (default and/or current limit(s) for risk and/or liquidity management)
- point in time when the limit becomes effective
- identification of the counterparty
Additional information on the generic design of the Get/Return messages can be found in the section How to Use the Cash Management Messages."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="RtrLmt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlcGxbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_imfkUZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jwlcHRbvEeiyVv5j1vf1VQ"
name="ReportOrError"
definition="Reports on limits."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_CtV4dW4-EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_jwlcHxbvEeiyVv5j1vf1VQ"
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="010"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.