camt.101.001.01
Scope The CreateLimit message is sent by a member to the transaction administrator. It is used to create one or several limits set by the member and managed by the transaction administrator. Usage Based on the criteria defined in the CreateLimit message, the transaction administrator will execute or reject the requested creation and respond with a Receipt message as a reply to the request.
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
%% CreateLimitV01 recursion level 0 with max 0
CreateLimitV01 *-- "1..1" MessageHeader1 : MessageHeader
CreateLimitV01 *-- "1..1" LimitStructure4 : LimitData
CreateLimitV01 *-- "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 |
LimitData 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
%% LimitStructure4 recursion level 0 with max 1
class LimitStructure4{
CreditDebitIndicator CreditDebitCode
}
LimitStructure4 *-- "1..1" LimitIdentification5 : LimitIdentification
LimitStructure4 *-- "0..1" IDateAndDateTime2Choice : StartDateTime
LimitStructure4 *-- "1..1" IAmount2Choice : Amount
%% LimitIdentification5 recursion level 1 with max 1
LimitIdentification5 *-- "0..1" ISystemIdentification2Choice : SystemIdentification
LimitIdentification5 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : BilateralLimitCounterpartyIdentification
LimitIdentification5 *-- "1..1" ILimitType1Choice : Type
LimitIdentification5 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : AccountOwner
LimitIdentification5 *-- "0..1" IAccountIdentification4Choice : AccountIdentification
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% IAmount2Choice recursion level 1 with max 1
LimitStructure4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| LimitIdentification | Identification of the default limit. | LimitIdentification5 - Required 1..1 |
| StartDateTime | Date and time at which the limit becomes effective. | IDateAndDateTime2Choice - Optional 0..1 |
| Amount | Amount of money of the limit, expressed in an eligible currency. | IAmount2Choice - Required 1..1 |
| CreditDebitIndicator | Specifies if a limit is a debit limit or a credit limit. | CreditDebitCode - Optional 0..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 CreateLimitV01 implementation follows a specific implementaiton pattern. First of all, CreateLimitV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CreateLimitV01Document implements IOuterDocument. Because CreateLimitV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CreateLimitV01.
classDiagram
class IOuterRecord
CreateLimitV01 --|> IOuterRecord : Implements
CreateLimitV01Document --|> IOuterDocument~CreateLimitV01~ : Implements
class IOuterDocument~CreateLimitV01~ {
CreateLimitV01 Message
}
Document wrapper for serialization
The only real purpose CreateLimitV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.101.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CreateLimitV01.ToDocument() method. The returned CreateLimitV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CreateLimitV01Document *-- CreateLimitV01 : 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.101.001.01">
<CretLmt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<LmtData>
<!-- LimitData inner content -->
</LmtData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CretLmt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_P8tBcckHEem3UrxZgQhVAw"
name="CreateLimitV01"
definition="Scope
The CreateLimit message is sent by a member to the transaction administrator.
It is used to create one or several limits set by the member and managed by the transaction administrator.
Usage
Based on the criteria defined in the CreateLimit message, the transaction administrator will execute or reject the requested creation and respond with a Receipt message as a reply to the request."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="CretLmt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_P8tBd8kHEem3UrxZgQhVAw"
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="_P8tBeckHEem3UrxZgQhVAw"
name="LimitData"
definition="Identifies one particular limit set by the member and managed by the transaction administrator."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="LmtData"
complexType="_LWX6EckIEem3UrxZgQhVAw" />
<messageBuildingBlock
xmi:id="_P8tBe8kHEem3UrxZgQhVAw"
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="101"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.