> For the complete documentation index, see [llms.txt](https://manual.boxexchanger.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.boxexchanger.net/dopolnitelnye-sistemy/okipays-moduli/okipays-auto-update-fee.md).
# Okipays auto update fee
{% stepper %}
{% step %}
## Описание модуля
Модуль "Okipays auto update fee" позволяет автоматически выставлять параметры "Сумма комиссии" и "Сумма потери" в направлениях, в которых для валюты вывода используется модуль выплаты Okipays. Значения для параметров выставляются в соответствии с комиссиями при выводе валюты на Okipays.
{% endstep %}
{% step %}
## Установка модуля
Используя параметры ниже, установите модуль через функционал "**Install plugin**" по инструкции [Install plugin](/dopolnitelnye-sistemy/install-plugin.md).
Параметры для Install Plugin
**Plugin type**: **`External module`**
**Plugin URL**: **`@boxexchanger-plugins/module-okipays-out-fee`**
**Directory path**: **`okipays-out-fee`**
**Auth: (Deploy token)**: оставляем пустым
**Package tag**: **`latest`**
{% endstep %}
{% step %}
## Конфигурация
{% hint style="info" %}
В случае, если вы уже зарегистрировались в Okipays и добавили мерчант в ЛК Okipays, то перейдите на страницу настроек мерчанта в ЛК Okipays и начните с шага 4.
{% endhint %}
1. [**Зарегистрируйтесь**](#user-content-fn-1)[^1] в Okipays по [**ссылке**](https://okipays.com/sign-up) -> войдите в ЛК.
2. В ЛК Okipays, перейдите на страницу "**Settings**" - раздел "**Merchant**" -> нажмите "[**Add merchant**](#user-content-fn-2)[^2]".
3. На страницу добавления мерчанта -> в поле "**Name**" укажите название мерчанта -> в поле "**Home URL**" укажите ссылку на ваш сайт в формате **`https://www.exchanger.com`** -> поставьте галочку напротив поля "**Generate API credentials**" -> в поле "**Result URL**" укажите любо ссылку на ваш сайт либо "IPN URL" из админ панели скрипта - страницы настроек мерчанта (если также будете использовать модуль приема Okipays. Инструкция: [Мерчант Okipays](/obmen/merchant-i-api/okipays/merchant-okipays.md)) -> скопируйте значения "**Token**" и "**Secret**" в надежное место.
4. После создания мерчанта из шага 3, на странице настроек мерчанта скопируйте значения "**Token**" и "**Secret**" в надежное место.
5. В админ панели скрипта зайдите на страницу "**Доп модули**" -> в разделе "**MODULE SYSTEM**" [**нажмите**](#user-content-fn-3)[^3] на значок настроек в блоке с модулем "**Okipays auto-update out fee**".
6. На странице настроек модуля, в поле "**API Key**" укажите значение "**Token**" из шага 4 -> нажмите "**Save**" -> в поле "**Secret Key**" укажите значение "**Secret**" из шага 4 -> нажмите "**Save**".
7. **API URL** - ссылка для API запросов Okipays. В случае, если у Okipays изменится ссылка для API запросов, то в поле "**API URL**" вы можете указать новую ссылку -> нажать "**Save**".
8. Для того чтобы включить модуль, на странице настроек "**Okipays auto-update out fee**" укажите значение "**1**" в поле "**Enable module**" -> нажмите "**Save**".
{% hint style="info" %}
По умолчанию, включенный модуль выставляет в направлении только значение для параметра "**Сумма потери**". \
В случае, если необходимо выставлять также и "**Сумму комиссии**", то необходимо включить поле "**Enable Update "Fee amount"**".
{% 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"**") исключительно в направлениях, в которых для валюты вывода используется модуль выплаты Okipays (который будет указан в следующем поле "**Check routes**"). | При данном параметре модуль будет устанавливать значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") в направлениях, в которых валюта (XML для которой будет указан в следующем поле "**Check routes**") выступает в качестве валюты вывода. |
9. В поле "**Check routes**" укажите:
1. Directory path модуля(-ей) выплаты Okipays, если на шаге 5 вы выбрали "**List of Payout key(s)**". Directory path модуля возможно найти на странице настроек модуля выплаты в адресной строке. Пример на [**скриншоте**](#user-content-fn-4)[^4]. \
**Пример**: **`okipays,okipays-2`** -> Нажмите "**Save**".
2. XML валют, если на шаге 5 вы выбрали "**List of XML(s)**". XML необходимо указывать в формате: **`XML1,XML2,XML3`** (заглавными буквами, через запятую, без пробелов)\
**Пример**: **`USDTTRC20,BTC,ETH,TRX,USDTERC20`** -> Нажмите "**Save**".
10. В поле "**Ignore routes by ID**" вы можете указать routeid направлений, которые модуль будет игнорировать при выставлении значений "Сумма потери" и "Сумма комиссии". \
**Пример**: **`662b69be181771c84d8176a8,662b69be181771c84d8176a9`** -> Нажмите "**Save**".
{% hint style="info" %}
**`routeid`** направления возможно найти на странице настроек направления в адресной строке. Пример на [**скриншоте**](#user-content-fn-5)[^5].
{% endhint %}
11. Через 60 секунд после сохранения параметров выше, модуль выставит значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") в направлениях, которые подходят под критерии. \
Каждые 60 секунд модуль обновляет значения "**Сумма потери**" и "**Сумма комиссии**", в случае если комиссия за вывод валюты на Okipays изменилась. К примеру, такой сценарий актуален для токенов в сети Ethereum (ERC20), так как на Okipays для подобных токенов динамическая комиссия на вывод.
{% endstep %}
{% endstepper %}
[^1]: 
[^2]: 
[^3]:
[^4]: 
[^5]: 