# Okipays auto min amount for TO currency

{% stepper %}
{% step %}

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

Модуль "**Okipays auto min amount for TO currency**" устанавливает минимальные лимиты для валюты выплаты по указанному проценту комиссии так, чтобы полученная прибыль от обмена по направлению, покрывала затраты на вывод валюты из Okipays. \
Данный модуль полезен для случаев, когда обменный пункт не хочет перекладывать комиссию за вывод с биржи (к примеру, для того чтобы на мониторингах располагаться выше в ТОПе) на клиента и покрывать данную комиссию за счет прибыли по направлению, которая будет обеспечена за счет больших лимитов по направлению.

**Формула для расчета**

<mark style="color:orange;">**`Минимальная сумма обмена = сумма статической комиссии вывода на Okipays / ((процент комисии - процент потери)/100)*inaccuracy`**</mark>

**Пример:** Направление USDT TRC20 - POL.

* Процент комиссии: 1.1%
* Процент потери: 0.1%
* Комиссия за вывод POL на Okipays: 0.1 POL

Если мы зададим значение inaccuracy - 1.0 (значение для безубытка), то в итоге мы получим:&#x20;

<mark style="color:orange;">**`Минимальная сумма обмена (POL) = 0.1 / ((1.1 - 0.1)/100)*1=10`**</mark>

Минимальные лимиты для направления USDT TRC20 - POL будут установлены 10 POL, так как именно при данной сумме обмена, чистая прибыль сможет покрыть потери 0.1 POL при выводе с Okipays

Стандартно для модуля значения inaccuracy указано 1.05, при таких значениях для этого примера минимальные лимиты будут 10.5 MATIC, что даст небольшую прибыль.
{% 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-control-route`**</mark>

**Directory path**: <mark style="color:orange;">**`okipays-control-route`**</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 min amount for TO currency**".
6. На странице настроек модуля, в поле "**API Key**" укажите значение "**Token**" из шага 4 -> нажмите "**Save**" -> в поле "**Secret Key**" укажите значение "**Secret**" из шага 4 -> нажмите "**Save**".
7. **API URL** - ссылка для API запросов Okipays. В случае, если у Okipays изменится ссылка для API запросов, то в поле "**API URL**" вы можете указать новую ссылку -> нажать "**Save**".
8. Для того чтобы включить модуль, на странице настроек "**Okipays auto min amount for TO currency**" укажите значение "**1**" в поле "**Enable module**" -> нажмите "**Save**".&#x20;
9. В поле "**inaccuracy**" укажите коэффициент для получения прибыли.

{% hint style="info" %}
К примеру, при значении <mark style="color:orange;">**`1`**</mark> модуль будет выставлять минимальный лимит для валюты, при котором обмен будет выполнен с нулевой прибылью. \
Однако, при значении <mark style="color:orange;">**`1.05`**</mark> модуль выставит минимальный лимит для валюты выплаты, при котором омбен будет выполнен с прибылью для обменного пункта.
{% endhint %}

8. В поле "**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**".
9. В поле "**Ignore routes by ID**" вы можете указать routeid направлений, которые модуль будет игнорировать при выставлении значений "Сумма потери" и "Сумма комиссии". \
   **Пример**: <mark style="color:green;">**`662b69be181771c84d8176a8,662b69be181771c84d8176a9`**</mark> -> Нажмите "**Save**".

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong><code>routeid</code></strong> направления возможно найти на странице настроек направления в адресной строке. Пример на <a data-footnote-ref href="#user-content-fn-5"><strong>скриншоте</strong></a>. </p></div>
10. **Debug log** - передача дополнительных логов команде BoxExchanger. В случае трудностей при работе модуля, установите значение "**Yes**" -> "**Save**" и обратитесь к поддержке BoxExchanger.
11. Через 60 секунд после сохранения параметров выше, модуль выставит минимальные лимиты  для валют выплаты в направлениях, которые подходят под критерии.\
    Каждые 60 секунд модуль обновляет минимальные лимиты  для валют выплаты, в случае если комиссия за вывод валюты на 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]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FclP34BAtukcropsZXmj7%2Fimage.png?alt=media\&token=646657f9-55d9-41e6-aa44-7979dce335bb)

[^4]: ![](https://3272217808-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKMtUdLxlDooDfKq13Is6%2Fuploads%2FlEHiqDI3I8MrCKC0RDNo%2Fimage.png?alt=media\&token=b9f2ffa3-03c8-4d10-a5f3-5884c1172bc5)

[^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-min-amount-for-to-currency.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.
