camt.016.001.04
Scope The GetCurrencyExchangeRate message is sent by a member to the transaction administrator. It is used to request information on static data maintained by the transaction administrator and related to currency exchange details as maintained for the system operations by the transaction administrator. Usage The transaction administrator is in charge of providing the members with business information. The term business information covers all information related to the management of the system, i.e., not related to the transactions created into the system. The type of business information available can vary depending on the system. When a system manages a pool of accounts in various currencies for a member, there is a need to maintain currency exchange details in between the various currencies and the reporting or base currency. The reporting or base currency is used to calculate the actual position of the members in terms of aggregate limits and balances and allow the system to contain risk within the defined and agreed boundaries. The currency exchange details can be fixed for the entire operational day, or regularly updated according to near real time market feeds. At any point in time during operating hours of the system, the member can query the transaction administrator to get information about the static data related to a currency exchange details. The member can request information based on the following elements:
- the currency to be converted (source currency)
- the currency into which the amount is converted (target currency) This message will be replied to by a ReturnCurrencyExchangeRate 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
%% GetCurrencyExchangeRateV04 recursion level 0 with max 0
GetCurrencyExchangeRateV04 *-- "1..1" MessageHeader1 : MessageHeader
GetCurrencyExchangeRateV04 *-- "0..1" CurrencyQueryDefinition3 : CurrencyQueryDefinition
GetCurrencyExchangeRateV04 *-- "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 |
CurrencyQueryDefinition building block
Definition of the currency exchange query. Defines the query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CurrencyQueryDefinition3 recursion level 0 with max 1
class CurrencyQueryDefinition3{
QueryType QueryType2Code
}
CurrencyQueryDefinition3 *-- "0..1" ICurrencyCriteriaDefinition1Choice : CurrencyCriteria
%% ICurrencyCriteriaDefinition1Choice recursion level 1 with max 1
CurrencyQueryDefinition3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| QueryType | Specifies the type of matching items to be returned in the response to the query. | QueryType2Code - Optional 0..1 |
| CurrencyCriteria | Defines of the currency query criteria. | ICurrencyCriteriaDefinition1Choice - 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 GetCurrencyExchangeRateV04 implementation follows a specific implementaiton pattern. First of all, GetCurrencyExchangeRateV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetCurrencyExchangeRateV04Document implements IOuterDocument. Because GetCurrencyExchangeRateV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetCurrencyExchangeRateV04.
classDiagram
class IOuterRecord
GetCurrencyExchangeRateV04 --|> IOuterRecord : Implements
GetCurrencyExchangeRateV04Document --|> IOuterDocument~GetCurrencyExchangeRateV04~ : Implements
class IOuterDocument~GetCurrencyExchangeRateV04~ {
GetCurrencyExchangeRateV04 Message
}
Document wrapper for serialization
The only real purpose GetCurrencyExchangeRateV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.016.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetCurrencyExchangeRateV04.ToDocument() method. The returned GetCurrencyExchangeRateV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetCurrencyExchangeRateV04Document *-- GetCurrencyExchangeRateV04 : 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.016.001.04">
<GetCcyXchgRate>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<CcyQryDef>
<!-- CurrencyQueryDefinition inner content -->
</CcyQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetCcyXchgRate>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlbdxbvEeiyVv5j1vf1VQ"
name="GetCurrencyExchangeRateV04"
definition="Scope
The GetCurrencyExchangeRate message is sent by a member to the transaction administrator.
It is used to request information on static data maintained by the transaction administrator and related to currency exchange details as maintained for the system operations by the transaction administrator.
Usage
The transaction administrator is in charge of providing the members with business information. The term business information covers all information related to the management of the system, i.e., not related to the transactions created into the system. The type of business information available can vary depending on the system.
When a system manages a pool of accounts in various currencies for a member, there is a need to maintain currency exchange details in between the various currencies and the reporting or base currency. The reporting or base currency is used to calculate the actual position of the members in terms of aggregate limits and balances and allow the system to contain risk within the defined and agreed boundaries. The currency exchange details can be fixed for the entire operational day, or regularly updated according to near real time market feeds.
At any point in time during operating hours of the system, the member can query the transaction administrator to get information about the static data related to a currency exchange details.
The member can request information based on the following elements:
- the currency to be converted (source currency)
- the currency into which the amount is converted (target currency)
This message will be replied to by a ReturnCurrencyExchangeRate message."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="GetCcyXchgRate"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlbeRbvEeiyVv5j1vf1VQ"
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="_jwlbexbvEeiyVv5j1vf1VQ"
name="CurrencyQueryDefinition"
definition="Definition of the currency exchange query."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CcyQryDef"
complexType="_Ho80EZlZEeeE1Ya-LgRsuQ" />
<messageBuildingBlock
xmi:id="_jwlbfRbvEeiyVv5j1vf1VQ"
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="016"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.