# Okipays control available
{% stepper %}
{% step %}
## Описание модуля
Модуль "**Okipays control available**" позволяет мониторить статус депозита/вывода валют на Okipays и в зависимости от их статуса отключать/включать направления, в которых Okipays используется в качестве модуль приема/выплаты. \
\
**Пример 1**: В случае если на Okipays будет временно закрыт депозит BTC, то модуль автоматически отключит все направления BTC->Сurrency, то есть в которых BTC является валютой приема. \
Далее, если депозит BTC станет снова доступен на Okipays, то модуль автоматически включит направления BTC->Сurrency. \
\
**Пример 2**: В случае если на Okipays будет временно закрыт вывод BTC, то модуль автоматически отключит все направления Currency->BTC, то есть в которых BTC является валютой вывода. \
Далее, если вывод BTC станет снова доступен на Okipays, то модуль автоматически включит направления Currency->BTC.
{% endstep %}
{% step %}
## Установка модуля
Используя параметры ниже, установите модуль через функционал "**Install plugin**" по инструкции [install-plugin](https://manual.boxexchanger.net/dopolnitelnye-sistemy/install-plugin "mention").
Параметры для Install Plugin
**Plugin type**: **`External module`**
**Plugin URL**: **`@boxexchanger-plugins/module-okipays-control-route`**
**Directory path**: **`okipays-control-route`**
**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. Инструкция: [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 control available**".
6. На странице настроек модуля, в поле "**API Key**" укажите значение "**Token**" из шага 4 -> нажмите "**Save**" -> в поле "**Secret Key**" укажите значение "**Secret**" из шага 4 -> нажмите "**Save**".
7. **API URL** - ссылка для API запросов Okipays. В случае, если у Okipays изменится ссылка для API запросов, то в поле "**API URL**" вы можете указать новую ссылку -> нажать "**Save**".
8. Для того чтобы включить модуль, на странице настроек "**Okipays control available**" укажите значение "**1**" в поле "**Enable module**" -> нажмите "**Save**".
9. Для проверки статуса депозита валют на прием, в поле "**Merchant IDs**" укажите Directory path модуля(-ей) приема Okipays. Directory path мерчанта возможно найти на странице настроек модуля приема в адресной строке. Пример на [**скриншоте**](#user-content-fn-4)[^4]. \
**Пример**: **`okipays,okipays-2`** -> Нажмите "**Save**".
{% hint style="info" %}
Модуль будет проверять статус депозита валют на Okipays и в зависимости от статуса включать/отключать направления, в которых для валюты приема установлен мерчант Okipays (Directory path которого вы указали в поле "**Merchant IDs**").
{% endhint %}
8. Для проверки статуса вывода валют на выплату, в поле "**Payout IDs**" укажите Directory path модуля(-ей) выплаты Okipays. Directory path выплаты возможно найти на странице настроек модуля выплаты в адресной строке. Пример на [**скриншоте**](#user-content-fn-5)[^5]. \
**Пример**: **`okipays,okipays-2`** -> Нажмите "**Save**".
{% hint style="info" %}
Модуль будет проверять статус вывода валют на Okipays и в зависимости от статуса включать/отключать направления, в которых для валюты вывода установлена выплата через Okipays (Directory path которого вы указали в поле "**Payout IDs**").
{% endhint %}
9. **Debug log** - передача дополнительных логов команде BoxExchanger. В случае трудностей при работе модуля, установите значение "**Yes**" -> "**Save**" и обратитесь к поддержке BoxExchanger.
10. Через 2 минуты после сохранения параметров выше, модуль начнет отключать направления, которые подходят под критерии. \
Каждые 2 минуты модуль обновляет информацию о статусе депозита/вывода валют и может отключать/включать направления, которые подходят под критерии.
{% endstep %}
{% endstepper %}
[^1]: 
[^2]: 
[^3]: 
[^4]: 
[^5]: 
---
# 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-control-available.md?ask=
```
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.