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