Basics
Quick Start

Use the quick currency and exchange direction addition function to significantly speed up the exchange setup process. Go to the "Currencies" page and click the "Add" - "Quick Add" button. After adding the currency, follow the same steps in the "Exchange Directions" page.

Manual Mode

To start working in manual mode, specify the payment details you want to receive payments to on the currency editing page. Then select "Merchant for Incoming Payments" - "Manual Payment Processing" on the exchange direction editing page.

Exchange Process

1) The user creates and pays for an order following the instructions.

2) After successful payment, the user needs to click the "Payment Completed" button.

3) The operator manually checks the transaction in the paysystem history. If the payment is received, the operator manually processes the order and changes its status to "Completed".

Disabling the Payment Confirmation Button

To do this, go to the "Application Settings" - "Manual Payment Processing Settings".

Adding a Transaction Payment Identifier Field

To do this, go to the "Application Settings" - "Manual Payment Processing Settings".

Editing Payment Instructions

To change the default payment instruction text, go to the "Template Settings" - "Words and Document Text". You can also provide a unique instruction on the exchange direction editing page in the "Description" tab.

Semi-Automatic Mode

To start working in semi-automatic mode, you need to configure the merchant. Then select "Payment Processing Merchant" on the exchange direction editing page.

Exchange Process

1) The user creates and pays for an order using the payment form or the merchant payment details.

2) After successful payment, the order automatically changes its status to "Paid".

3) The operator manually processes the order and changes its status to "Completed".

User Verification

User verification can be used to restrict access to exchange directions. Verification is available in two types: 1) identity verification; 2) bank card verification. You can change the verification type in the "Application Settings" - "Verification Settings".

To enable verification, go to the exchange direction editing page and select "Verification Type" - "Only for Verified Users".

Bonus System

The bonus system allows for more favorable exchange conditions for loyal customers. The bonus is added to the amount of the received currency during the exchange. The bonus size may depend on the exchange turnover or be unique to a specific user. The exchange turnover is automatically calculated in the user base currency balance after each successfully completed exchange.

To configure the bonus system, go to the "Application Settings" - "Bonus System Settings".

User Balance

User balance is an internal currency used in the referral and investment programs, and can also serve as an electronic payment system wallet.

Any currency or exchange direction can be used to work with the user balance. You can create a currency like "Balance USD" using the identifier "BALANCE" and work with it like any other currency. Deposits and withdrawals are made through the exchange direction with the payment processing merchant "User Balance".

By default, the user balance is represented in "USD" equivalent. You can change the base currency in the "Application Settings" - "Registration and Authorization Settings".

Referral Program

Rewards are given for each successfully completed exchange and credited to the user balance. The reward size may depend on the turnover of referral exchanges or be unique to a specific user. The turnover of referral exchanges is automatically calculated in the user base currency balance after each successfully completed exchange. The reward is calculated based on the exchange amount.

To configure the referral program, go to the "Application Settings" - "Referral Program Settings".

Base Exchange Rate Parser

Conversion of the reward amount into the user balance currency is based on the base exchange rate parser, which defaults to using Binance data.

To change the base exchange rate parser, go to the "Application Settings" - "General Application Settings".

Investment Program

Investing is done by opening a deposit in the user profile with payment through the user balance. Interest is accrued to the user balance. The principal of the deposit will be returned at the end of the investment period.

To configure the investment program, go to the "Application Settings" - "Investment Program Settings". The "Interest Accrual Interval" field can contain an integer from 1 to 365, indicating the number of days for interest accrual.

Automatic Exchange Rate Updates

If you need to automatically update exchange rates, you can use a set of built-in exchange rate parsers that work based on your configured settings. The exchange rate parser settings are located on the exchange direction editing page, under the "Exchange Rate Parser" tab.

Setting Example

Exchange Rate Parser Pair Calculation Method Correction Type Correction Amount Description
HTX BTCUSDT - - - Get the BTC/USDT exchange rate on HTX exchange
Binance USDTETH Amount Exchange Rate of Outgoing Currency 100 Get the USDT/ETH Exchange Rate on Binance (+100 USDT)
Forex USDUAH Percent Exchange Rate of Incoming Currency -5 Get the USD/UAH Exchange Rate on Forex (-5%)

Formulas

By using a formula as the exchange rate parser and an expression as the pair, you can calculate exchange rates from multiple sources using arithmetic and logical operators.

Writing a formula starts with the letter "S" (outgoing currency) or "R" (received currency), allowing you to set the exchange rate in the format "X = 1" or "1 = X". To obtain the exchange rate, use the notation "{EXCHANGERATEPARSER:PAIR}".

Formula Examples

Calculate the BCH/LTC exchange rate on the Binance exchange:

S {BINANCE:BCHUSDT} / {BINANCE:LTCUSDT}

Calculate the average exchange rate of BTC/USDT on Binance and HTX exchanges:

R ({BINANCE:BTCUSDT} + {HUOBI:BTCUSDT}) / 2

Get the BTC/USDT exchange rate on the HTX exchange if it cannot be obtained on the Binance exchange:

S {BINANCE:BTCUSDT} ? {BINANCE:BTCUSDT} : {HUOBI:BTCUSDT}

Calculate the UAH/DOGE exchange rate using PrivatBank and Binance exchanges:

R {PRIVATBANK:UAHUSD} * {BINANCE:DOGEUSDT}

Get the ETH/USD exchange rate if the USDT/USD exchange rate on the WhiteBIT exchange is less than 0.90 or greater than 1.10, otherwise get the ETH/USDT exchange rate:

S {WHITEBIT:USDTUSD} < 0.90 || {WHITEBIT:USDTUSD} > 1.10 ? {WHITEBIT:ETHUSD} : {WHITEBIT:ETHUSDT}

Calculate the USDT/TRX exchange rate in the format of 1 USDT = X TRX using the WhiteBIT exchange:

R 1 / {WHITEBIT:TRXUSDT}

Formula Calculator

The formula calculator is located on the exchange direction editing page and is used to test more complex formulas with multiple conditions.

1) Paste or start typing the formula in the "Formula" field.

2) Fill in the variable values in the "Variables" field, simulating the actual exchange rate. To automatically generate the list of formula variables, remove all data from the field.

3) Modify any data and observe the final exchange rate.

Constants

Constants can be used to store various numeric values, with their further use in formulas or as a pair for the rate parser, this can be useful for quickly changing the exchange rate for many exchange directions or writing complex exchange rate formation scripts.

Example of using constants

Get the USD/UAH exchange rate using PrivatBank and increase it as a percentage by the value of the constant UAHFEE:

R {PRIVATBANK:USDUAH} + (({PRIVATBANK:USDUAH} * {CONSTANT:UAHFEE}) / 100)

Get the ETH/USDT exchange rate on the Binance exchange if the value of the USEBINANCE constant is set to one, otherwise get the ETH/USDT exchange rate on the WhiteBIT exchange:

R {CONSTANT:USEBINANCE} == 1 ? {BINANCE:ETHUSDT} : {WHITEBIT:ETHUSDT}

To configure constants, go to the "Application Settings" - "Exchange Rate Parser Constants Settings".

Dynamic Exchange Rate

If you need to automatically update exchange rates until an order is paid, you can enable the dynamic exchange rate option on the exchange direction editing page. By default, the exchange rate is fixed after creating an order.

Exchange Rate Export

To obtain data, you need to send a GET request to one of the following URL addresses:

Format URL Address
XML https://YOUR.DOMAIN/rates-export/xml
TXT https://YOUR.DOMAIN/rates-export/txt
JSON https://YOUR.DOMAIN/rates-export/json
JSON https://YOUR.DOMAIN/rates-export-another-json-v1

Access Restriction

Access to data can be restricted using an access token. To configure the access token, go to the "Application Settings" - "Exchange Rate Export Settings".

Example URL with an access token:

https://YOUR.DOMAIN/rates-export/json/ACCESS_TOKEN
We work without days off 10:00 - 20:00 (GMT+3)
© 2018 - 2024 Made with Exchanger CMS