|
tag |
Document
|
type |
Document |
path: |
/Document[1..1] |
X-path: |
/Document |
mode: |
|
minOccurs |
1 |
maxOccurs |
1 |
Elements: |
|
|
Document [Sequence] |
|
RtrCcyXchgRate |
|
|
|
tag |
RtrCcyXchgRate
|
type |
ReturnCurrencyExchangeRateV04 |
fullName |
ReturnCurrencyExchangeRateV04 |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1] |
X-path: |
/Document/RtrCcyXchgRate |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Message Definition |
Scope
The ReturnCurrencyExchangeRate message is sent by the transaction administrator to
a member of the system.
It is used to provide information on static data and related to currency exchange
details as maintained for system operations by the transaction administrator.
The ReturnCurrencyExchangeRate message can be sent as a response to a related GetCurrencyExchangeRate
message (pull mode) or initiated by the account servicer (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
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, that is, not related to the transactions or requests created in 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, it needs
to maintain currency exchange details between the various currencies and the reporting
on base currency. The reporting on base currency is used to calculate the actual position
of the members in terms of aggregate limits and balances. It also allows the system
to contain risk within 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.
The member can request information about a currency exchange operation through a series
of criteria, corresponding to the known information stored within the transaction
administrator. Based on the criteria received within the request, the transaction
administrator will select items that will match with the request and report them to
the requestor.
The transaction administrator may also send a Return Currency Exchange Rate 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 the member(s)
attention.
The message from the transaction administrator will contain information based on the
following elements:
- the currency to be converted (source currency)
- the currency into which the amount is converted (target currency)
- the exchange rate
- the quotation date and currency
Additional information on the generic design of the Get/Return messages can be found
in the MDR Part 1 section How to Use the Cash Management Messages.
|
Building Block: |
|
|
Name |
MessageHeader |
|
Definition |
Common business identification for the message. |
Building Block: |
|
|
Name |
ReportOrError |
|
Definition |
Reports on currency exchange information. |
Building Block: |
|
|
Name |
SupplementaryData |
|
Definition |
Additional information that cannot be captured in the structured elements and/or any
other specific block.
|
|
RtrCcyXchgRate
|
tag |
MsgHdr
|
type |
MessageHeader7 |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1] |
X-path: |
/Document/RtrCcyXchgRate/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/RtrCcyXchgRate/MsgHdr [Sequence] |
|
MsgId |
Message Identification |
|
CreDtTm |
Creation Date Time |
|
ReqTp |
Request Type |
|
OrgnlBizQry |
Original Business Query |
|
QryNm |
Query Name |
|
RtrCcyXchgRate +MsgHdr
|
tag |
MsgId
|
type |
Max35Text |
fullName |
MessageIdentification |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/MsgId[1..1] |
X-path: |
/Document/RtrCcyXchgRate/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.
|
|
RtrCcyXchgRate +MsgHdr
|
tag |
CreDtTm
|
type |
ISODateTime |
fullName |
CreationDateTime |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/CreDtTm[0..1] |
X-path: |
/Document/RtrCcyXchgRate/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.
|
|
RtrCcyXchgRate +MsgHdr
|
tag |
ReqTp
|
type |
RequestType4Choice |
fullName |
RequestType |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Request Type
|
|
ISO Element Definition |
Specific actions to be executed through the request.
|
|
ISO Type Definition |
Defines the type of action to be performed in the request.
|
Elements: |
|
|
Document/RtrCcyXchgRate/MsgHdr/ReqTp [Choice] |
|
PmtCtrl |
Payment Control |
|
Enqry |
Enquiry |
|
Prtry |
Proprietary |
|
RtrCcyXchgRate +MsgHdr ++ReqTp
|
tag |
PmtCtrl
|
type |
ExternalPaymentControlRequestType1Code |
fullName |
PaymentControl |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/PmtCtrl[1..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/PmtCtrl |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
4 |
Documentation: |
|
|
ISO Element Name |
Payment Control
|
|
ISO Type Definition |
Specifies the external request type code for a payment control command in the format
of character string with a maximum length of 4 characters.
The list of valid codes is an external code set published separately.
External code sets can be downloaded from www.iso20022.org.
|
|
RtrCcyXchgRate +MsgHdr ++ReqTp
|
tag |
Enqry
|
type |
ExternalEnquiryRequestType1Code |
fullName |
Enquiry |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/Enqry[1..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/Enqry |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
4 |
Documentation: |
|
|
ISO Element Name |
Enquiry
|
|
ISO Type Definition |
Specifies the external request type code for the enquiry on a position in the format
of character string with a maximum length of 4 characters.
The list of valid codes is an external code set published separately.
External code sets can be downloaded from www.iso20022.org.
|
|
RtrCcyXchgRate +MsgHdr ++ReqTp
|
tag |
Prtry
|
type |
GenericIdentification1 |
fullName |
Proprietary |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/Prtry[1..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/Prtry |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Proprietary
|
|
ISO Type Definition |
Information related to an identification, for example party identification or account
identification.
|
Elements: |
|
|
Document/RtrCcyXchgRate/MsgHdr/ReqTp/Prtry [Sequence] |
|
Id |
Identification |
|
SchmeNm |
Scheme Name |
|
Issr |
Issuer |
|
RtrCcyXchgRate +MsgHdr ++ReqTp +++Prtry
|
tag |
Id
|
type |
Max35Text |
fullName |
Identification |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/Prtry[1..1]/Id[1..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/Prtry/Id |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
35 |
Documentation: |
|
|
ISO Element Name |
Identification
|
|
ISO Element Definition |
Identification assigned by an institution.
|
|
RtrCcyXchgRate +MsgHdr ++ReqTp +++Prtry
|
tag |
SchmeNm
|
type |
Max35Text |
fullName |
SchemeName |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/Prtry[1..1]/SchmeNm[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/Prtry/SchmeNm |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
35 |
Documentation: |
|
|
ISO Element Name |
Scheme Name
|
|
ISO Element Definition |
Name of the identification scheme.
|
|
RtrCcyXchgRate +MsgHdr ++ReqTp +++Prtry
|
tag |
Issr
|
type |
Max35Text |
fullName |
Issuer |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/ReqTp[0..1]/Prtry[1..1]/Issr[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/ReqTp/Prtry/Issr |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
35 |
Documentation: |
|
|
ISO Element Name |
Issuer
|
|
ISO Element Definition |
Entity that assigns the identification.
|
|
RtrCcyXchgRate +MsgHdr
|
tag |
OrgnlBizQry
|
type |
OriginalBusinessQuery1 |
fullName |
OriginalBusinessQuery |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/OrgnlBizQry[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/OrgnlBizQry |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Original Business Query
|
|
ISO Element Definition |
Unique identification of the original query message.
|
|
ISO Type Definition |
Unique identification, as assigned by the original requestor, to unambiguously identify
the business query message.
|
Elements: |
|
|
Document/RtrCcyXchgRate/MsgHdr/OrgnlBizQry [Sequence] |
|
MsgId |
Message Identification |
|
MsgNmId |
Message Name Identification |
|
CreDtTm |
Creation Date Time |
|
RtrCcyXchgRate +MsgHdr ++OrgnlBizQry
|
tag |
MsgId
|
type |
Max35Text |
fullName |
MessageIdentification |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/OrgnlBizQry[0..1]/MsgId[1..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/OrgnlBizQry/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 original initiating party, to unambiguously
identify the original query message.
|
|
RtrCcyXchgRate +MsgHdr ++OrgnlBizQry
|
tag |
MsgNmId
|
type |
Max35Text |
fullName |
MessageNameIdentification |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/OrgnlBizQry[0..1]/MsgNmId[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/OrgnlBizQry/MsgNmId |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
35 |
Documentation: |
|
|
ISO Element Name |
Message Name Identification
|
|
ISO Element Definition |
Specifies the query message name identifier to which the message refers.
|
|
RtrCcyXchgRate +MsgHdr ++OrgnlBizQry
|
tag |
CreDtTm
|
type |
ISODateTime |
fullName |
CreationDateTime |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/OrgnlBizQry[0..1]/CreDtTm[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/OrgnlBizQry/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.
|
|
RtrCcyXchgRate +MsgHdr
|
tag |
QryNm
|
type |
Max35Text |
fullName |
QueryName |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/MsgHdr[1..1]/QryNm[0..1] |
X-path: |
/Document/RtrCcyXchgRate/MsgHdr/QryNm |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
35 |
Documentation: |
|
|
ISO Element Name |
Query Name
|
|
ISO Element Definition |
Recalls the criteria (search and return criteria) defined in a preceding query.
|
|
RtrCcyXchgRate
|
tag |
RptOrErr
|
type |
ExchangeRateReportOrError1Choice |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Type Definition |
It is used to provide information on static data maintained by the transaction administrator
and related to currency exchange details as maintained for system operations by the
transaction administrator.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr [Choice] |
|
CcyXchgRpt |
Currency Exchange Report |
|
OprlErr |
Operational Error |
|
RtrCcyXchgRate +RptOrErr
|
tag |
CcyXchgRpt
|
type |
CurrencyExchangeReport3 |
fullName |
CurrencyExchangeReport |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
unbounded |
Documentation: |
|
|
ISO Element Name |
Currency Exchange Report
|
|
ISO Type Definition |
Reports either on currency exchange information or on a business error.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt [Sequence] |
|
CcyRef |
Currency Reference |
|
CcyXchgOrErr |
Currency Exchange Or Error |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt
|
tag |
CcyRef
|
type |
CurrencySourceTarget1 |
fullName |
CurrencyReference |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyRef[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyRef |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Currency Reference
|
|
ISO Element Definition |
Source and target currencies for which information is request.
|
|
ISO Type Definition |
Information needed to process a currency exchange or conversion.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyRef [Sequence] |
|
SrcCcy |
Source Currency |
|
TrgtCcy |
Target Currency |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyRef
|
tag |
SrcCcy
|
type |
ActiveOrHistoricCurrencyCode |
fullName |
SourceCurrency |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyRef[1..1]/SrcCcy[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyRef/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.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyRef
|
tag |
TrgtCcy
|
type |
ActiveOrHistoricCurrencyCode |
fullName |
TargetCurrency |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyRef[1..1]/TrgtCcy[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyRef/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.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt
|
tag |
CcyXchgOrErr
|
type |
ExchangeRateReportOrError2Choice |
fullName |
CurrencyExchangeOrError |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Currency Exchange Or Error
|
|
ISO Element Definition |
Reports either on currency exchange information or on a business error.
|
|
ISO Type Definition |
Reports either on currency exchange information or on a business error.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr [Choice] |
|
BizErr |
Business Error |
|
CcyXchg |
Currency Exchange |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr
|
tag |
BizErr
|
type |
ErrorHandling3 |
fullName |
BusinessError |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/BizErr[1..unbounded] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
unbounded |
Documentation: |
|
|
ISO Element Name |
Business Error
|
|
ISO Type Definition |
Specifies the error resulting from the processing of a request.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr [Sequence] |
|
Err |
Error |
|
Desc |
Description |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++BizErr
|
tag |
Err
|
type |
ErrorHandling1Choice |
fullName |
Error |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/BizErr[1..unbounded]/Err[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr/Err |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Error
|
|
ISO Element Definition |
Specification of the error, in coded or proprietary form.
|
|
ISO Type Definition |
Specifies the choice between the listed and the proprietary error codes.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr/Err [Choice] |
|
Cd |
Code |
|
Prtry |
Proprietary |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++BizErr +++++Err
|
tag |
Cd
|
type |
ErrorHandling1Code |
fullName |
Code |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/BizErr[1..unbounded]/Err[1..1]/Cd[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr/Err/Cd |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Enumeration: |
|
X020 |
Definition |
Specifies the error code when the data requested are not yet available. |
Name |
DataNotYetAvailable |
ISO Definition |
Specifies the error code when the data requested are not yet available. |
ISO Name |
DataNotYetAvailable |
|
|
X030 |
Definition |
Specifies the error code when the data requested generates a message size that exceed
the processing capacity.
|
Name |
MessageSizeLimitExceeded |
ISO Definition |
Specifies the error code when the data requested generates a message size that exceed
the processing capacity.
|
ISO Name |
MessageSizeLimitExceeded |
|
|
X050 |
Definition |
Specifies the error code when the data requested have not been found. |
Name |
DataNotAvailable |
ISO Definition |
Specifies the error code when the data requested have not been found. |
ISO Name |
DataNotAvailable |
|
Documentation: |
|
|
ISO Element Name |
Code
|
|
ISO Type Definition |
Error codes generated when the response to a query exceeds the maximum size or the
data is not available.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++BizErr +++++Err
|
tag |
Prtry
|
type |
Max4AlphaNumericText |
fullName |
Proprietary |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/BizErr[1..unbounded]/Err[1..1]/Prtry[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr/Err/Prtry |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Pattern: |
[a-zA-Z0-9]{1,4} |
minLength |
1 |
maxLength |
4 |
Documentation: |
|
|
ISO Element Name |
Proprietary
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++BizErr
|
tag |
Desc
|
type |
Max140Text |
fullName |
Description |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/BizErr[1..unbounded]/Desc[0..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/BizErr/Desc |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
140 |
Documentation: |
|
|
ISO Element Name |
Description
|
|
ISO Element Definition |
Specification of the error, in free format.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr
|
tag |
CcyXchg
|
type |
CurrencyExchange7 |
fullName |
CurrencyExchange |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/CcyXchg[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/CcyXchg |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Currency Exchange
|
|
ISO Type Definition |
Information needed to process a currency exchange or conversion.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/CcyXchg [Sequence] |
|
XchgRate |
Exchange Rate |
|
QtdCcy |
Quoted Currency |
|
QtnDt |
Quotation Date |
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++CcyXchg
|
tag |
XchgRate
|
type |
BaseOneRate |
fullName |
ExchangeRate |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/CcyXchg[1..1]/XchgRate[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/CcyXchg/XchgRate |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
fractionDigits |
10 |
totalDigits |
11 |
Documentation: |
|
|
ISO Element Name |
Exchange Rate
|
|
ISO Element Definition |
The value of one currency expressed in relation to another currency. ExchangeRate
expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
|
|
ISO Type Definition |
Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++CcyXchg
|
tag |
QtdCcy
|
type |
ActiveOrHistoricCurrencyCode |
fullName |
QuotedCurrency |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/CcyXchg[1..1]/QtdCcy[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/CcyXchg/QtdCcy |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Pattern: |
[A-Z]{3,3} |
Documentation: |
|
|
ISO Element Name |
Quoted Currency
|
|
ISO Element Definition |
Currency into which the base currency is converted, in a currency exchange.
|
|
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.
|
|
RtrCcyXchgRate +RptOrErr ++CcyXchgRpt +++CcyXchgOrErr ++++CcyXchg
|
tag |
QtnDt
|
type |
ISODateTime |
fullName |
QuotationDate |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/CcyXchgRpt[1..unbounded]/CcyXchgOrErr[1..1]/CcyXchg[1..1]/QtnDt[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/CcyXchgRpt/CcyXchgOrErr/CcyXchg/QtnDt |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Quotation Date
|
|
ISO Element Definition |
Date and time at which an exchange rate is quoted.
|
|
RtrCcyXchgRate +RptOrErr
|
tag |
OprlErr
|
type |
ErrorHandling3 |
fullName |
OperationalError |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/OprlErr[1..unbounded] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/OprlErr |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
unbounded |
Documentation: |
|
|
ISO Element Name |
Operational Error
|
|
ISO Type Definition |
Specifies the error resulting from the processing of a request.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/OprlErr [Sequence] |
|
Err |
Error |
|
Desc |
Description |
|
RtrCcyXchgRate +RptOrErr ++OprlErr
|
tag |
Err
|
type |
ErrorHandling1Choice |
fullName |
Error |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/OprlErr[1..unbounded]/Err[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/OprlErr/Err |
mode: |
Sequence |
minOccurs |
1 |
maxOccurs |
1 |
Documentation: |
|
|
ISO Element Name |
Error
|
|
ISO Element Definition |
Specification of the error, in coded or proprietary form.
|
|
ISO Type Definition |
Specifies the choice between the listed and the proprietary error codes.
|
Elements: |
|
|
Document/RtrCcyXchgRate/RptOrErr/OprlErr/Err [Choice] |
|
Cd |
Code |
|
Prtry |
Proprietary |
|
RtrCcyXchgRate +RptOrErr ++OprlErr +++Err
|
tag |
Cd
|
type |
ErrorHandling1Code |
fullName |
Code |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/OprlErr[1..unbounded]/Err[1..1]/Cd[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/OprlErr/Err/Cd |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Enumeration: |
|
X020 |
Definition |
Specifies the error code when the data requested are not yet available. |
Name |
DataNotYetAvailable |
ISO Definition |
Specifies the error code when the data requested are not yet available. |
ISO Name |
DataNotYetAvailable |
|
|
X030 |
Definition |
Specifies the error code when the data requested generates a message size that exceed
the processing capacity.
|
Name |
MessageSizeLimitExceeded |
ISO Definition |
Specifies the error code when the data requested generates a message size that exceed
the processing capacity.
|
ISO Name |
MessageSizeLimitExceeded |
|
|
X050 |
Definition |
Specifies the error code when the data requested have not been found. |
Name |
DataNotAvailable |
ISO Definition |
Specifies the error code when the data requested have not been found. |
ISO Name |
DataNotAvailable |
|
Documentation: |
|
|
ISO Element Name |
Code
|
|
ISO Type Definition |
Error codes generated when the response to a query exceeds the maximum size or the
data is not available.
|
|
RtrCcyXchgRate +RptOrErr ++OprlErr +++Err
|
tag |
Prtry
|
type |
Max4AlphaNumericText |
fullName |
Proprietary |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/OprlErr[1..unbounded]/Err[1..1]/Prtry[1..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/OprlErr/Err/Prtry |
mode: |
Choice |
minOccurs |
1 |
maxOccurs |
1 |
Pattern: |
[a-zA-Z0-9]{1,4} |
minLength |
1 |
maxLength |
4 |
Documentation: |
|
|
ISO Element Name |
Proprietary
|
|
RtrCcyXchgRate +RptOrErr ++OprlErr
|
tag |
Desc
|
type |
Max140Text |
fullName |
Description |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/RptOrErr[1..1]/OprlErr[1..unbounded]/Desc[0..1] |
X-path: |
/Document/RtrCcyXchgRate/RptOrErr/OprlErr/Desc |
mode: |
Sequence |
minOccurs |
0 |
maxOccurs |
1 |
minLength |
1 |
maxLength |
140 |
Documentation: |
|
|
ISO Element Name |
Description
|
|
ISO Element Definition |
Specification of the error, in free format.
|
|
RtrCcyXchgRate
|
tag |
SplmtryData
|
type |
SupplementaryData1 |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/SplmtryData[0..unbounded] |
X-path: |
/Document/RtrCcyXchgRate/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/RtrCcyXchgRate/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.
|
|
RtrCcyXchgRate +SplmtryData
|
tag |
PlcAndNm
|
type |
Max350Text |
fullName |
PlaceAndName |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/SplmtryData[0..unbounded]/PlcAndNm[0..1] |
X-path: |
/Document/RtrCcyXchgRate/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.
|
|
RtrCcyXchgRate +SplmtryData
|
tag |
Envlp
|
type |
SupplementaryDataEnvelope1 |
fullName |
Envelope |
path: |
/Document[1..1]/RtrCcyXchgRate[1..1]/SplmtryData[0..unbounded]/Envlp[1..1] |
X-path: |
/Document/RtrCcyXchgRate/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/RtrCcyXchgRate/SplmtryData/Envlp [Sequence] |
|