# Okipays auto update fee

{% stepper %}
{% step %}

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

Модуль "Okipays auto update fee" позволяет автоматически выставлять параметры "Сумма комиссии" и "Сумма потери" в направлениях, в которых для валюты вывода используется модуль выплаты Okipays. Значения для параметров выставляются в соответствии с комиссиями при выводе валюты на Okipays.
{% 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-okipays-out-fee`**</mark>

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

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

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

</details>
{% 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**" укажите ссылку на ваш сайт в формате <mark style="color:orange;">**`https://www.exchanger.com`**</mark> -> поставьте галочку напротив поля "**Generate API credentials**" -> в поле "**Result URL**" укажите любо ссылку на ваш сайт либо "IPN URL" из админ панели скрипта - страницы настроек мерчанта (если также будете использовать модуль приема Okipays. Инструкция: [merchant-okipays](https://manual.boxexchanger.net/obmen/merchant-i-api/okipays/merchant-okipays "mention")) -> скопируйте значения "**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**".&#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"**") исключительно в направлениях, в которых для валюты вывода используется модуль выплаты Okipays (который будет указан в следующем поле "**Check routes**"). | При данном параметре модуль будет устанавливать значения "**Сумма потери**" и "**Сумма комиссии**" (если включено поле "**Enable Update "Fee amount"**") в направлениях, в которых валюта (XML для которой будет указан в следующем поле "**Check routes**") выступает в качестве валюты вывода. |

9. В поле "**Check routes**" укажите:&#x20;
   1. Directory path модуля(-ей) выплаты Okipays, если на шаге 5 вы выбрали "**List of Payout key(s)**". Directory path модуля возможно найти на странице настроек модуля выплаты в адресной строке. Пример на [**скриншоте**](#user-content-fn-4)[^4]. \
      **Пример**: <mark style="color:green;">**`okipays,okipays-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-5)[^5].&#x20;
{% endhint %}

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

[^1]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FY6qJkFYx2LKsktUWBblw%2Fimage.png?alt=media\&token=0a18a9f3-fe88-459b-83dd-a4ad4ffeb44c)

[^2]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FaIzCydz33WuwuxPTU7To%2Fimage.png?alt=media\&token=c254d531-3d37-4994-9c1a-0993bd524512)

[^3]:

[^4]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FPqgr3oc6rVFOReCwKF8V%2Fimage.png?alt=media\&token=7468e84b-e800-4b60-95da-7a1a91dd6bdf)

[^5]: ![](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)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://manual.boxexchanger.net/dopolnitelnye-sistemy/okipays-moduli/okipays-auto-update-fee.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.