tag Document
type Document
path: /Document[1..1]
X-path: /Document
mode:
minOccurs 1
maxOccurs 1
Elements:
Document [Sequence]
GetCcyXchgRate
tag GetCcyXchgRate
type GetCurrencyExchangeRateV04
fullName GetCurrencyExchangeRateV04
path: /Document[1..1]/GetCcyXchgRate[1..1]
X-path: /Document/GetCcyXchgRate
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Message 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.
Building Block:
Name MessageHeader
Definition Common business identification for the message.
Building Block:
Name CurrencyQueryDefinition
Definition Definition of the currency exchange query.
Building Block:
Name SupplementaryData
Definition Additional information that cannot be captured in the structured elements and/or any other specific block.
GetCcyXchgRate
tag MsgHdr
type MessageHeader1
path: /Document[1..1]/GetCcyXchgRate[1..1]/MsgHdr[1..1]
X-path: /Document/GetCcyXchgRate/MsgHdr
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Type Definition Set of characteristics, such as the identification or the creation date and time, specific to the message.
Elements:
Document/GetCcyXchgRate/MsgHdr [Sequence]
MsgId Message Identification
CreDtTm Creation Date Time
GetCcyXchgRate
+MsgHdr
tag MsgId
type Max35Text
fullName MessageIdentification
path: /Document[1..1]/GetCcyXchgRate[1..1]/MsgHdr[1..1]/MsgId[1..1]
X-path: /Document/GetCcyXchgRate/MsgHdr/MsgId
mode: Sequence
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Message Identification
ISO Element Definition Point to point reference, as assigned by the sender, to unambiguously identify the message.
ISO Element Usage The sender has to make sure that MessageIdentification is unique for a pre-agreed period.
GetCcyXchgRate
+MsgHdr
tag CreDtTm
type ISODateTime
fullName CreationDateTime
path: /Document[1..1]/GetCcyXchgRate[1..1]/MsgHdr[1..1]/CreDtTm[0..1]
X-path: /Document/GetCcyXchgRate/MsgHdr/CreDtTm
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Creation Date Time
ISO Element Definition Date and time at which the message was created.
GetCcyXchgRate
tag CcyQryDef
type CurrencyQueryDefinition3
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Type Definition Defines the query criteria.
Elements:
Document/GetCcyXchgRate/CcyQryDef [Sequence]
QryTp Query Type
CcyCrit Currency Criteria
GetCcyXchgRate
+CcyQryDef
tag QryTp
type QueryType2Code
fullName QueryType
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/QryTp[0..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/QryTp
mode: Sequence
minOccurs 0
maxOccurs 1
Enumeration:
ALLL
Definition Specifies that the query requests that all matching items be returned.
Name All
ISO Definition Specifies that the query requests that all matching items be returned.
ISO Name All
CHNG
Definition Specifies that the query requests that only new matching items since the last similar query be returned.
Name Changed
ISO Definition Specifies that the query requests that only new matching items since the last similar query be returned.
ISO Name Changed
MODF
Definition Specifies that the query requests that only items that have changed since the last query be returned.
Name Modified
ISO Definition Specifies that the query requests that only items that have changed since the last query be returned.
ISO Name Modified
DELD
Definition Specifies that the query requests that items that have been deleted since the last query be returned.
Name Deleted
ISO Definition Specifies that the query requests that items that have been deleted since the last query be returned.
ISO Name Deleted
Documentation:
ISO Element Name Query Type
ISO Element Definition Specifies the type of matching items to be returned in the response to the query.
ISO Type Definition Specifies the nature of the query, i.e. whether the query requests that all matching items be returned or only new matching items since the last similar query be returned.
GetCcyXchgRate
+CcyQryDef
tag CcyCrit
type CurrencyCriteriaDefinition1Choice
fullName CurrencyCriteria
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Currency Criteria
ISO Element Definition Defines of the currency query criteria.
ISO Type Definition Defines the information that is searched either implicitly by recalling a previous query or explicitly by defining the criteria.
Elements:
Document/GetCcyXchgRate/CcyQryDef/CcyCrit [Choice]
QryNm Query Name
NewCrit New Criteria
GetCcyXchgRate
+CcyQryDef
++CcyCrit
tag QryNm
type Max35Text
fullName QueryName
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/QryNm[1..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/QryNm
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Query Name
GetCcyXchgRate
+CcyQryDef
++CcyCrit
tag NewCrit
type CurrencyExchangeCriteria2
fullName NewCriteria
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/NewCrit[1..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit
mode: Choice
minOccurs 1
maxOccurs 1
Documentation:
ISO Element Name New Criteria
ISO Type Definition Defines the criteria used to search for currency exchange information. A name may be given to the new query.
Elements:
Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit [Sequence]
NewQryNm New Query Name
SchCrit Search Criteria
GetCcyXchgRate
+CcyQryDef
++CcyCrit
+++NewCrit
tag NewQryNm
type Max35Text
fullName NewQueryName
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/NewCrit[1..1]/NewQryNm[0..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit/NewQryNm
mode: Sequence
minOccurs 0
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name New Query Name
ISO Element Definition Name of the query defined by the search criteria and return criteria.
GetCcyXchgRate
+CcyQryDef
++CcyCrit
+++NewCrit
tag SchCrit
type CurrencyExchangeSearchCriteria1
fullName SearchCriteria
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/NewCrit[1..1]/SchCrit[1..unbounded]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit/SchCrit
mode: Sequence
minOccurs 1
maxOccurs unbounded
Documentation:
ISO Element Name Search Criteria
ISO Element Definition Defines the criteria based on which the information is extracted.
ISO Type Definition Defines the criteria used to search for currency exchange information.
Elements:
Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit/SchCrit [Sequence]
SrcCcy Source Currency
TrgtCcy Target Currency
GetCcyXchgRate
+CcyQryDef
++CcyCrit
+++NewCrit
++++SchCrit
tag SrcCcy
type ActiveOrHistoricCurrencyCode
fullName SourceCurrency
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/NewCrit[1..1]/SchCrit[1..unbounded]/SrcCcy[1..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit/SchCrit/SrcCcy
mode: Sequence
minOccurs 1
maxOccurs 1
Pattern: [A-Z]{3,3}
Documentation:
ISO Element Name Source Currency
ISO Element Definition Currency of the amount to be converted in a currency conversion.
ISO Type Definition A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Constraint:
Name ActiveOrHistoricCurrency
Definition The Currency Code must be registered, or have already been registered. Valid active or historic currency codes are registered with the ISO 4217 Maintenance Agency, consist of three (3) contiguous letters, and may be or not be withdrawn on the day the message containing the Currency is exchanged.
GetCcyXchgRate
+CcyQryDef
++CcyCrit
+++NewCrit
++++SchCrit
tag TrgtCcy
type ActiveOrHistoricCurrencyCode
fullName TargetCurrency
path: /Document[1..1]/GetCcyXchgRate[1..1]/CcyQryDef[0..1]/CcyCrit[0..1]/NewCrit[1..1]/SchCrit[1..unbounded]/TrgtCcy[1..1]
X-path: /Document/GetCcyXchgRate/CcyQryDef/CcyCrit/NewCrit/SchCrit/TrgtCcy
mode: Sequence
minOccurs 1
maxOccurs 1
Pattern: [A-Z]{3,3}
Documentation:
ISO Element Name Target Currency
ISO Element Definition Currency into which an amount is to be converted in a currency conversion.
ISO Type Definition A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Constraint:
Name ActiveOrHistoricCurrency
Definition The Currency Code must be registered, or have already been registered. Valid active or historic currency codes are registered with the ISO 4217 Maintenance Agency, consist of three (3) contiguous letters, and may be or not be withdrawn on the day the message containing the Currency is exchanged.
GetCcyXchgRate
tag SplmtryData
type SupplementaryData1
path: /Document[1..1]/GetCcyXchgRate[1..1]/SplmtryData[0..unbounded]
X-path: /Document/GetCcyXchgRate/SplmtryData
mode: Sequence
minOccurs 0
maxOccurs unbounded
Documentation:
ISO Type Definition Additional information that can not be captured in the structured fields and/or any other specific block.
Elements:
Document/GetCcyXchgRate/SplmtryData [Sequence]
PlcAndNm Place And Name
Envlp Envelope
Constraint:
Name SupplementaryDataRule
Definition This component may not be used without the explicit approval of a SEG and submission to the RA of ISO 20022 compliant structure(s) to be used in the Envelope element.
GetCcyXchgRate
+SplmtryData
tag PlcAndNm
type Max350Text
fullName PlaceAndName
path: /Document[1..1]/GetCcyXchgRate[1..1]/SplmtryData[0..unbounded]/PlcAndNm[0..1]
X-path: /Document/GetCcyXchgRate/SplmtryData/PlcAndNm
mode: Sequence
minOccurs 0
maxOccurs 1
minLength 1
maxLength 350
Documentation:
ISO Element Name Place And Name
ISO Element Definition 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.
GetCcyXchgRate
+SplmtryData
tag Envlp
type SupplementaryDataEnvelope1
fullName Envelope
path: /Document[1..1]/GetCcyXchgRate[1..1]/SplmtryData[0..unbounded]/Envlp[1..1]
X-path: /Document/GetCcyXchgRate/SplmtryData/Envlp
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Element Name Envelope
ISO Element Definition Technical element wrapping the supplementary data.
ISO Type Definition Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
Elements:
Document/GetCcyXchgRate/SplmtryData/Envlp [Sequence]