Exported rates file format
This page contains the description of the standard for generating exported rates file supported by the BestChange.com exchanger monitor. It is based on the XML format with the abbreviated currency names from Estandards.
- The export file is generated in the XML format;
- Every entry starts on a new line. A new line is started by the \n character;
- A full stop is used as a decimal point for numerical values;
- The root element is <rates>;
- Every exchange direction is described in the <item> element;
- Elements for describing each direction of exchange:
- <from> – source currency code. Electronic currency codes are listed below;
- <to> – destination currency code. Electronic currency codes are listed below;
- <in> – how much from currency the customer has to give;
- <out> – how much to currency the customer will get;
- <amount> – the to currency reserve in the exchanger;
- <minfee> – is a minimal commission which is calculated for the difference between the currency the user gives and the equivalent of the currency the user gets in the reference with the average exchange rate. You must specify it with the code of the national currency.
Example: <minfee>5 USD</minfee>
Please take into account that minfee has no reference with the commissions fromfee and tofee, the minimal commission for the commission the customer gives and the customer gets is not calculated in our system, please avoid such forming of the rate. See usage examples. - <fromfee> – the additional commission fee that is not included in the exchange rate and is taken from the sum the user transfers to the exchanger. You must specify it with the code of the national currency.
Example: <fromfee>2.15 EUR</fromfee>
Possible national currency codes are listed below. It is also possible to use the % character instead of the national currency code in order to specify the additional commission fee in percentage terms; - <tofee> – the additional commission fee that is not included in the exchange rate and is taken from the sum the exchanger transfers to the user. You must specify it with the code of the national currency.
Example: <tofee>2 EUR</tofee>
Possible national currency codes are listed below. It is also possible to use the % character instead of the national currency code in order to specify the additional commission fee in percentage terms; - <minamount> – the minimal amount of currency for exchanging that the exchanger can take from a client. You must specify it with the code of the national currency.
Example: <minamount>4.1 USD</minamount>
If you have several limits on minimal amount, for example, a separate amount for receiving and for paying, you must specify the maximal value of such limitation in the field of minamount converted in the from currency. If it is not possible to select the maximal value from several minimal amounts, you must specify additional fields minamount with a separate minimal amount in each one; - <maxamount> – the maximal amount of currency the exchanger can take from a client for a one-time transaction. You must specify it with the code of the national currency.
Example: <maxamount>5000 USD</maxamount>
If you have several limits on maximal amount, for example a separate amount for receiving and for paying, you must specify the minimal value of such limitation in the field of maxiamount converted in the from currency. If it is not possible to select the minimal value from several maximal amounts, you must specify additional fields maxamount with a separate maximal amount in each one; - <param> – this tag is used to specify additional properties, such as:
- manual – the property must be specified for all non-automatic, non-instant exchange directions (for manual, operator-controlled, etc.);
- juridical – this property means that the exchanger transfers money to the user bank account from a juridical account. This label is applicable only for directions * —› Wire;
- verifying – this property means that the exchanger can require ID documents from their client in order to perform the exchange operation;
- cardverify – this property means that the exchanger can require verification of a bank card;
- floating – floating rate, which is not fixed in the order. At the same time, the amount of exchange can change at the moment of sending funds to the client;
- otherin – receiving customer's funds is being done on a side payment system, not on the one specified in the field from;
- otherout – payment of fund to the client is being done from the side payment system, not the one specified in the field to;
- reg – to make an exchange the user must register on the site of the exchanger;
- card2card – exchanger accepts users' funds by means of Card2Card transfers (not via card merchant). This label is applicable only for directions Visa/MasterCard —› *.
Example: <param>manual, floating</param> - <city> – to specify cities where the exchange exchanges e-currencies into cash or vice versa. It makes sense to specify this field only for cash operations. The export file can have direction with various specified cities.
Example: <city>ANTR</city>
- You do not need to specify constant commissions of payment systems in your rates export file. Our monitoring counts them on its own.
Codes of electronic currencies
|
Codes of national currencies
Codes of cities
|
Example
<rates>
<item>
<from>WMZ</from>
<to>WMX</to>
<in>1</in>
<out>30.593562</out>
<amount>572962.42</amount>
<minamount>3 USD</minamount>
<maxamount>1000 USD</maxamount>
</item>
<item>
<from>ADVCUSD</from>
<to>PMUSD</to>
<in>1</in>
<out>0.978</out>
<amount>2921.42</amount>
<minamount>2 USD</minamount>
<maxamount>2000 USD</maxamount>
<minfee>7 USD</minfee>
<param>manual</param>
</item>
<item>
<from>BTC</from>
<to>ETH</to>
<in>1</in>
<out>24.90782568</out>
<amount>673.10</amount>
<minamount>2 USD</minamount>
<maxamount>0.42341216 BTC</maxamount>
<tofee>1 %</tofee>
<param>manual, juridical</param>
</item>
<item>
<from>BTC</from>
<to>CASHUSD</to>
<in>1</in>
<out>4342.352344</out>
<amount>31.90343295</amount>
<minamount>1.5 USD</minamount>
<maxamount>1000 USD</maxamount>
<minfee>5 USD</minfee>
<city>ANTR</city>
</item>
</rates>
<item>
<from>WMZ</from>
<to>WMX</to>
<in>1</in>
<out>30.593562</out>
<amount>572962.42</amount>
<minamount>3 USD</minamount>
<maxamount>1000 USD</maxamount>
</item>
<item>
<from>ADVCUSD</from>
<to>PMUSD</to>
<in>1</in>
<out>0.978</out>
<amount>2921.42</amount>
<minamount>2 USD</minamount>
<maxamount>2000 USD</maxamount>
<minfee>7 USD</minfee>
<param>manual</param>
</item>
<item>
<from>BTC</from>
<to>ETH</to>
<in>1</in>
<out>24.90782568</out>
<amount>673.10</amount>
<minamount>2 USD</minamount>
<maxamount>0.42341216 BTC</maxamount>
<tofee>1 %</tofee>
<param>manual, juridical</param>
</item>
<item>
<from>BTC</from>
<to>CASHUSD</to>
<in>1</in>
<out>4342.352344</out>
<amount>31.90343295</amount>
<minamount>1.5 USD</minamount>
<maxamount>1000 USD</maxamount>
<minfee>5 USD</minfee>
<city>ANTR</city>
</item>
</rates>
Example link to exported rates file
FAQ for Export rates file
- Our export file is updated every minute. Is this fast enough?
-
No, it is not enough. Our monitoring requests exchange rates every 5-8 seconds, therefore, to increase precision of the data transferred, it is required that your exchanger provides export file which would contain information representing exchange rates equivalent to those on your web page.
One of the following options of export implementation can be used:- A script that generates new export data on every request;
- Static export file being generated every time any change of rates/reserves/commissions occurs on your exchanger web page.
- What commissions must be rendered in the export file?
-
Your rates in the monitor must take in account:
- All fees connected with sending funds from the exchanger's side, charged to the amount received by the user;
- All fees connected with sending funds from the user's side, with the exception of commissions charged by payment system, if the payment takes place within this payment system.
- Our exchanger has several levels of rates depending on the sum to be exchanged. How should we specify it in our export file?
- Our monitoring does not support multilevel rates. In this case, exchange rates with maximum percentage available should be reported.
- Our exchanger has limits with regard to the maximum sum to be exchanged at a time. How should we specify it in our export file?
-
To implement this, you should make correction of reserves respective to set limits in the exchange directions where the limits are applicable.
Example: Perfect Money USD → PayPal EUR direction is limited to accept maximum of 1000 USD Perfect Money. In this case, you should set 1000 USD reserve in target currency, this is to convert 1000 USD in EUR.
If a limit equal to 0 is set, such directions should not be exported, or their reserve should also be 0.
- Is it possible to set up our display in your list so that we are displayed from Monday to Saturday 9:00 to 19:00, but were not displayed on Sunday?
-
There are 2 ways to do it:
- Set up the export rates generation script so that the export file is cleared automatically (or rates or reserves are set to 0) on the days when you are not working;
- Enable or disable the listing of your exchanger manually using corresponding link in your bestchange.org account.
If you have any questions, you can ask them by contacting us with the help of the methods specified on the contacts page.