> For the complete documentation index, see [llms.txt](https://docs.iexexchanger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iexexchanger.com/guide/integracii/merchanty-i-api/avtovyplaty/cryptoway.md).

# CryptoWay

{% hint style="danger" %}
Перед настройкой автоматических выплат обязательно ознакомьтесь с предупреждением о рисках.

Автоматическая выплата отправляет реальные средства без дополнительного подтверждения. Ошибка в настройках валюты, сети или направления может привести к потере средств.
{% endhint %}

{% hint style="warning" %}
Перед включением автоматических выплат обязательно выполните тестовую выплату на небольшую сумму.

API-ключ должен иметь разрешение **Withdrawal**. Если для ключа разрешены только депозиты, выплаты выполняться не будут.
{% endhint %}

CryptoWay — криптовалютный сервис, который позволяет автоматически отправлять криптовалюту клиентам через API.

После подключения iEXExchanger самостоятельно создаёт выплату, отслеживает её статус и автоматически завершает заявку после успешной отправки средств.

Модуль поддерживает:

* автоматическую отправку криптовалюты;
* проверку статуса выплаты;
* получение хеша транзакции;
* передачу Memo или Tag;
* работу с несколькими блокчейн-сетями;
* обработку промежуточных и ошибочных статусов.

### Что нужно подготовить

Перед настройкой подготовьте следующие данные из кабинета CryptoWay:

`API Key ID`

`API Key Secret`

Для автоматических выплат API-ключ должен иметь разрешение:

**Withdrawal — операции с выводом средств**

Разрешение **Deposits** используется для приёма платежей и для работы автовыплаты не требуется.

Один API-ключ можно использовать одновременно для приёма и выплат, если для него включены оба разрешения. В целях безопасности рекомендуется создать отдельный ключ для автоматических выплат.

***

### Регистрация в CryptoWay

Перейдите на официальный сайт: <https://cryptoway.com/ru>

<figure><img src="https://1156649716-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYuqSN6CIJoIeh8EPb0uE%2Fuploads%2Fgit-blob-60c429ecf2ef4c6550dbc5fc981a65417c692a5d%2Fimage.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

Создайте аккаунт или войдите в существующий.

После входа:

1. Перейдите в раздел **«API ключи»**.
2. Нажмите **«Создать API ключ»**.
3. Укажите произвольное название ключа.
4. При необходимости укажите публичный IP-адрес вашего сервера.
5. Включите разрешение **Withdrawal**.
6. Подтвердите создание ключа.
7. Скопируйте `Key ID` и `Key Secret`.

Сохраните полученные данные в безопасном месте и не передавайте их третьим лицам.

{% hint style="warning" %}
`Key Secret` показывается только при создании ключа. Повторно посмотреть его не получится. Если ключ не был сохранён, потребуется создать новую пару ключей.
{% endhint %}

Если список разрешённых IP-адресов оставить пустым, CryptoWay может автоматически сохранить IP-адрес первого успешного API-запроса. Последующие запросы будут приниматься только с этого IP.

Для рабочего подключения рекомендуется сразу указать публичный IP Backend-сервера обменного пункта.

***

Для добавления модуля откройте: **«Мерчанты и API» → «Список автовыплат»**

<figure><img src="https://1156649716-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYuqSN6CIJoIeh8EPb0uE%2Fuploads%2Fgit-blob-46559896e69aa5118245aaecc668ecbe5789aa44%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Нажмите **«Добавить»**.

В списке модулей выберите **Cryptoway**.

### Настройка автовыплаты

<figure><img src="https://1156649716-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYuqSN6CIJoIeh8EPb0uE%2Fuploads%2Fgit-blob-c57b260d7fbbf7fb1d9ef981b034f84259928b37%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

#### API Key ID

Укажите идентификатор API-ключа из кабинета CryptoWay.

Пример:

`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`

Поле обязательно для заполнения.

У API-ключа должно быть включено разрешение **Withdrawal**.
{% endstep %}

{% step %}

#### API Key Secret

Укажите секретную часть API-ключа.

Она используется для подписи запросов:

* создания выплаты;
* проверки статуса выплаты;
* получения списка доступных валют и сетей.

Поле обязательно для заполнения.

Не добавляйте пробелы в начале или конце значения.
{% endstep %}

{% step %}

#### API Base URL

Оставьте стандартное значение:

`https://api.cryptoway.com`

Изменяйте это поле только по рекомендации технической поддержки CryptoWay.

Не указывайте здесь адрес личного кабинета или домен вашего обменного пункта.
{% endstep %}
{% endstepper %}

<figure><img src="https://1156649716-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYuqSN6CIJoIeh8EPb0uE%2Fuploads%2Fgit-blob-5f339f4edcee22e82d39fa557b071684ee47f9d3%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Код валюты

Выберите код валюты и блокчейн-сети, в которой будет выполняться выплата.

Например:

* `USDTTRC20`
* `USDTBEP20`
* `BNBBEP20`

Для выплаты USDT в сети TRC20 необходимо выбрать:

* `USDTTRC20`

Для выплаты USDT в сети BEP20:

* `USDTBEP20`

Использовать только общий код валюты, например `USDT`, нельзя. CryptoWay принимает код валюты, привязанный к конкретной блокчейн-сети.

Сеть должна полностью совпадать с сетью валюты, которую клиент получает по заявке.

Если выбрано значение **«Автоматически»**, система будет использовать код сети из настроек валюты. Перед запуском обязательно убедитесь, что этот код соответствует идентификатору валюты в CryptoWay.

{% hint style="info" %}
Если в заявке указан адрес сети TRC20, а в модуле выбрана сеть BEP20, выплата может завершиться ошибкой или привести к потере средств.
{% endhint %}

***

### Привязка автовыплаты к валюте

После сохранения автовыплаты её необходимо назначить валюте, которую клиент получает по заявке.

Откройте: **«Основное» → «Валюты» → «Список валют»**

Выберите необходимую валюту и перейдите в раздел автоматизации.

<figure><img src="https://1156649716-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYuqSN6CIJoIeh8EPb0uE%2Fuploads%2Fgit-blob-2089c1083e1e7c9e65e5a7c53499dcdd2d3ce77e%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

В качестве автовыплаты выберите **Cryptoway**.

Проверьте соответствие:

* валюты в iEXExchanger;
* блокчейн-сети;
* кода валюты в настройках автовыплаты.

Если одна валюта используется в нескольких сетях, рекомендуется создать отдельную копию автовыплаты для каждой сети.

{% content-ref url="/pages/zEyPL7CgzEo11hFHLWrh" %}
[Автоматизация валют с разными сетями](https://docs.iexexchanger.com/guide/integracii/merchanty-i-api/avtomatizaciya-valyut-s-raznymi-setyami.md)
{% endcontent-ref %}

***

### Проверка статуса выплаты

Статус выплаты проверяется через API CryptoWay.

Для корректной проверки статуса необходимо:

* чтобы API-ключ оставался активным;
* чтобы у ключа было разрешение **Withdrawal**;
* чтобы публичный IP сервера был разрешён;
* чтобы время на сервере было синхронизировано;
* чтобы Backend имел доступ к `https://api.cryptoway.com`;
* чтобы на сервере выполнялись фоновые задачи iEXExchanger.

### Что проверить перед запуском

Перед использованием автоматических выплат убедитесь, что:

* `API Key ID` заполнен правильно;
* `API Key Secret` заполнен правильно;
* для API-ключа включено разрешение **Withdrawal**;
* `API Base URL` имеет значение `https://api.cryptoway.com`;
* код валюты и сеть указаны без ошибок;
* не используется виртуальный код без сети, например `USDT`;
* публичный IP сервера разрешён в настройках API-ключа;
* автовыплата привязана к нужной валюте или направлению;
* на балансе CryptoWay достаточно средств;
* на балансе есть дополнительная сумма для оплаты комиссии;
* сумма выплаты не ниже минимального лимита CryptoWay;
* адрес получателя соответствует выбранной сети;
* для валют с Memo или Tag настроено соответствующее поле;
* во время тестирования включено логирование запросов.

### Проверка работы

Перед использованием на реальных заявках рекомендуется выполнить тестовую выплату.

Порядок проверки:

1. Создайте тестовое направление.
2. Привяжите автовыплату **Cryptoway**.
3. Выберите правильный код валюты и сети.
4. Укажите небольшую сумму.
5. Создайте тестовую заявку.
6. Запустите выплату.
7. Проверьте появление операции в кабинете CryptoWay.
8. Дождитесь изменения статуса на `executed`.
9. Проверьте получение хеша транзакции.
10. Убедитесь, что клиент получил правильную сумму.
11. Проверьте сумму комиссии, списанную с баланса.
12. Убедитесь, что заявка успешно завершилась.

Журнал запросов находится в разделе: **«Журнал событий» → «Мерчанты и API» → «Лог запросов автовыплат»**

***

### Рекомендации

Используйте отдельный API-ключ CryptoWay только для автоматических выплат.

Разрешите для него только операцию **Withdrawal** и ограничьте доступ публичным IP-адресом Backend-сервера.

Не публикуйте `API Key ID` и `API Key Secret` в переписках и на скриншотах.

Перед включением автоматических выплат всегда выполняйте несколько тестовых операций с небольшими суммами.

Отдельно протестируйте каждую используемую валюту и блокчейн-сеть.

Отдельно протестируйте валюты, для которых требуется Memo или Tag.

Не запускайте выплату повторно, если первая операция имеет неизвестный или промежуточный статус.

После успешной проверки можно отключить расширенное логирование запросов.

***

### Коротко

Для подключения автоматических выплат через CryptoWay необходимо:

1. Зарегистрироваться в CryptoWay.
2. Создать API-ключ с разрешением **Withdrawal**.
3. Получить `API Key ID` и `API Key Secret`.
4. Добавить модуль **Cryptoway** в разделе автовыплат.
5. Заполнить обязательные поля.
6. Оставить стандартный `API Base URL`.
7. Выбрать правильный код валюты и сети.
8. Привязать автовыплату к валюте или направлению.
9. Проверить баланс, комиссию и минимальную сумму.
10. Выполнить тестовую выплату.
11. Убедиться, что выплата получила статус `executed`.
12. Проверить хеш транзакции и успешное завершение заявки.
