# CryptoCash auto update fee

{% stepper %}
{% step %}

## Описание модуля

Модуль "CryptoCash auto update fee" позволяет автоматически выставлять параметры "Сумма комиссии" и "Сумма потери" в направлениях, в которых для валюты вывода используется модуль выплаты CryptoCash. Значения для параметров выставляются в соответствии с комиссиями при выводе валюты на CryptoCash.
{% endstep %}

{% step %}

## Установка модуля

Используя параметры ниже, установите модуль через функционал "**Install plugin**" по инструкции [install-plugin](https://manual.boxexchanger.net/dopolnitelnye-sistemy/install-plugin "mention").

<details>

<summary>Параметры для Install Plugin</summary>

**Plugin type**: <mark style="color:orange;">**`External module`**</mark>

**Plugin URL**: <mark style="color:orange;">**`@boxexchanger-plugins/module-crypto-cash-out-fee`**</mark>

**Directory path**: <mark style="color:orange;">**`crypto-cash-out-fee`**</mark>

**Auth: (Deploy token)**: оставляем пустым

**Package tag**: <mark style="color:orange;">**`latest`**</mark>

</details>
{% endstep %}

{% step %}

## Конфигурация

{% hint style="info" %}
В случае, если вы уже зарегистрировались в CryptoCash и сгенерировали, а также сохранили значения "**Public key**" и "**Private key**" из ЛК CryptoCash, то перейдите к шагу 3.
{% endhint %}

1. [**Зарегистрируйтесь**](#user-content-fn-1)[^1] в CryptoCash по [ссылке](https://account.crypto-cash.world/registration) -> [войдите](https://account.crypto-cash.world/login) в ЛК.
2. На странице "**Overview**" - в блоке "**Merchant Settings**" нажмите "[**To settings**](#user-content-fn-2)[^2]" -> в модальном окне нажмите "[**Generate API Key**](#user-content-fn-3)[^3]" -> [**скопируйте**](#user-content-fn-4)[^4] значения "**Public key**" и "**Private key**" в надежное место.

{% hint style="info" %}
Обратите внимание, что значения "**Public key**" и "**Private key**" также понадобятся для настройки [merchant-cryptocash](https://manual.boxexchanger.net/obmen/merchant-i-api/cryptocash/merchant-cryptocash "mention"), [vyplaty-cryptocash](https://manual.boxexchanger.net/obmen/merchant-i-api/cryptocash/vyplaty-cryptocash "mention") и [](https://manual.boxexchanger.net/dopolnitelnye-sistemy/cryptocash-moduli "mention"). Сохраните секретный ключ в надежном месте, пока модули CryptoCash не будут настроены. **В противном случае вам придется пересоздавать "Secret Key" так как после перезагрузки страницы ключ будет скрыт в целях безопасности.**
{% endhint %}

3. В админ панели скрипта зайдите на страницу "**Доп модули**" -> в разделе "**MODULE SYSTEM**" [**нажмите**](#user-content-fn-5)[^5] на значок настроек в блоке с модулем "**CryptoCash auto-update out fee**".
4. На странице настроек модуля, в поле "**Public Key**" укажите значение "**Public key**" из шага 2 -> нажмите "**Save**" -> в поле "**Secret Key**" укажите значение "**Private key**" из шага 2 -> нажмите "**Save**".
5. **API URL** - ссылка для API запросов CryptoCash. В случае, если у CryptoCash изменится ссылка для API запросов, то в поле "**API URL**" вы можете указать новую ссылку -> нажать "**Save**".
6. Для того чтобы включить модуль, на странице настроек "**CryptoCash auto-update out fee**" укажите значение "**1**" в поле "**Enable module**" -> нажмите "**Save**".&#x20;

{% hint style="info" %}
По умолчанию, включенный модуль выставляет в направлении только значение для параметра "**Сумма потери**". \
В случае, если необходимо выставлять также и "**Сумму комиссии**", то необходимо включить поле "**Enable Update "Fee amount"**".&#x20;
{% endhint %}

7. В поле "**Enable Update "Fee amount"**" укажите один из вариантов по таблице ниже -> Нажмите "**Save**".

|                                                    0                                                    |                                                   1                                                  |
| :-----------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: |
| Значение "**0**", если не требуется чтобы модуль автоматически выставлял значение "**Сумма комиссии**". | Значение "**1**", если требуется чтобы модуль автоматически выставлял значение "**Сумма комиссии**". |

8. Для поля "**Routes detect by**" выберите один из вариантов по таблице ниже -> Нажмите "**Save**".

|                                                                                                                                                 List of Payout key(s)                                                                                                                                                 |                                                                                                                                          List of XML(s)                                                                                                                                          |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| При данном параметре модуль будет устанавливать значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") исключительно в направлениях, в которых для валюты вывода используется модуль выплаты CryptoCash (который будет указан в следующем поле "**Check routes**"). | При данном параметре модуль будет устанавливать значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") в направлениях, в которых валюта (XML для которой будет указан в следующем поле "**Check routes**") выступает в качестве валюты вывода. |

9. В поле "**Check routes**" укажите:&#x20;
   1. Directory path модуля(-ей) выплаты CryptoCash, если на шаге 5 вы выбрали "**List of Payout key(s)**". Directory path модуля возможно найти на странице настроек модуля выплаты в адресной строке. Пример на [**скриншоте**](#user-content-fn-6)[^6]. \
      **Пример**: <mark style="color:green;">**`crypto-cash,crypto-cash-2`**</mark> -> Нажмите "**Save**".
   2. XML валют, если на шаге 5 вы выбрали "**List of XML(s)**". XML необходимо указывать в формате: <mark style="color:green;">**`XML1,XML2,XML3`**</mark> (заглавными буквами, через запятую, без пробелов)\
      **Пример**: <mark style="color:green;">**`USDTTRC20,BTC,ETH,TRX,USDTERC20`**</mark> -> Нажмите "**Save**".
10. В поле "**Ignore routes by ID**" вы можете указать routeid направлений, которые модуль будет игнорировать при выставлении значений "Сумма потери" и "Сумма комиссии". \
    **Пример**: <mark style="color:green;">**`662b69be181771c84d8176a8,662b69be181771c84d8176a9`**</mark> -> Нажмите "**Save**".

{% hint style="info" %}
**`routeid`** направления возможно найти на странице настроек направления в адресной строке. Пример на [**скриншоте**](#user-content-fn-7)[^7].&#x20;
{% endhint %}

11. Через 60 секунд после сохранения параметров выше, модуль выставит значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") в направлениях, которые подходят под критерии. \
    Каждые 60 секунд модуль обновляет значения "**Сумма потери**" и "**Сумма комиссии**", в случае если комиссия за вывод валюты на CryptoCash изменилась. К примеру, такой сценарий актуален для токенов в сети Ethereum (ERC20), так как на CryptoCash для подобных токенов динамическая комиссия на вывод.&#x20;
    {% endstep %}
    {% endstepper %}

[^1]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FLDsqGI8McdqHBd0KY4Ko%2Fimage.png?alt=media\&token=92b94150-0caf-47a6-9f48-a8219652b78d)

[^2]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FhiTKPrDN6Y3knmUlnGP7%2Fimage.png?alt=media\&token=17cd080a-f5f3-42ac-855c-8228209c5fd6)

[^3]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FBTb3HyC8SYy0RRKEa56t%2Fimage.png?alt=media\&token=56ddb775-d038-4830-925f-cd55d077fce2)

[^4]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FDuZT1nUZmmrK1ni9ZPGl%2Fimage.png?alt=media\&token=1fc41553-1e10-4567-9f2c-aa3e755f660a)

[^5]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FF7jXfW8kOaL9yNyDIOHn%2Fimage.png?alt=media\&token=b6998e45-e9ba-4f62-a83f-62ecc36445db)

[^6]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FsqOoOhRZJrvi8KNkTIrT%2Fimage.png?alt=media\&token=9f3eaa70-929d-48e7-9655-73326c56007f)

[^7]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FfsRwjtc3TkRuuwtaWDEC%2Fimage.png?alt=media\&token=c10c15da-bfc8-427c-9919-1cf51a428b39)
