Cryptoway Cryptoway docs

Cryptoway API Documentation

Введение

API интеграции

Endpoint: https://api.cryptoway.com

Cryptoway API подписывается по схеме HMAC-SHA256. Документация состоит из четырёх разделов:

Подпись

Подпись

Ключи

КлючГде взятьДля чего
Project ID + secretЛичный кабинет, раздел API keysПодпись запросов к API
callback_keyЛичный кабинет, профильПроверка webhook

Для webhook используйте callback_key, не secret API key.

Получение ключей API

Один API key можно использовать для всех методов API, если при создании включены нужные разрешения.

Параметры при создании ключа

ПараметрОписание
descriptionНазвание ключа
allowed_ipsСписок разрешённых IP. Можно оставить пустым
is_deposit_allowedРазрешить операции с депозитами
is_withdrawal_allowedРазрешить выводы

Если allowed_ips пуст, первый успешный запрос с API автоматически добавит текущий IP в список.

Инструкция

  1. Зарегистрируйтесь в сервисе.
  2. Перейдите во вкладку «API ключи».
  3. Нажмите «Создать API ключ».
  4. Укажите название, разрешения и IP в форме создания.
  5. После сохранения сразу запишите ключи из модального окна. Secret показывается один раз.
  6. Готово.

В запросах используйте Project ID как X-API-Key-ID, а secret — для подписи. Имя заголовка не менялось: значение из кабинета называется Project ID, а передаётся в X-API-Key-ID.

callback_key

Ключ для проверки webhook находится в профиле личного кабинета. Он не совпадает с secret API key.

Заголовки запроса к API

ЗаголовокОписание
X-API-Key-IDProject ID (UUID)
X-TimestampUnix timestamp, секунды
X-SignatureHMAC-SHA256 hex

Подпись обязательна для всех публичных эндпоинтов (метод GET, POST и др.).

Алгоритм подписи API

  1. Соберите объект:
{
  "params": "url_encoded_query_string",
  "body": {},
  "path": "/user/balance/"
}
  • params — query string как в URL (search_query=foo, без ?)
  • body — JSON тела запроса; {} если тела нет
  • path — путь запроса, например /user/balance/
  1. Сериализуйте объект: json.dumps(data, separators=(",", ":"), sort_keys=True)
  2. Подпись:
signature = HMAC-SHA256(key=API_KEY_SECRET, message=timestamp + json_string)
  1. Timestamp должен быть в пределах ±15 секунд от серверного времени.

Если allowlist ключа пуст, при первом успешном запросе текущий IP записывается в allowlist. Дальнейшие запросы принимаются только с IP из списка.

Пример: GET баланс

# params пустые, body {}
# path = /user/balance/
# data = {"body":{},"params":"","path":"/user/balance/"}

curl "https://api.cryptoway.com/user/balance/" \
  -H "X-API-Key-ID: <PROJECT_ID>" \
  -H "X-Timestamp: 1718659200" \
  -H "X-Signature: <hex>"

Пример: POST адрес

curl "https://api.cryptoway.com/user/address/" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key-ID: <PROJECT_ID>" \
  -H "X-Timestamp: 1718659200" \
  -H "X-Signature: <hex>" \
  -d '{"symbol_id":"USDTBEP20","callback_url":"https://example.com/cb","description":"shop"}'

Генерация подписи

:::tabs

import hashlib, hmac, json, time

def sign(key: str, timestamp: int, data: dict) -> str:
    s = json.dumps(data, separators=(",", ":"), sort_keys=True)
    return hmac.new(key.encode(), f"{timestamp}{s}".encode(), hashlib.sha256).hexdigest()

data = {"params": "", "body": {"symbol_id": "USDTBEP20"}, "path": "/user/address/"}
ts = int(time.time())
signature = sign(API_KEY_SECRET, ts, data)
$data = ["params" => "", "body" => ["symbol_id" => "USDTBEP20"], "path" => "/user/address/"];
ksort($data);
$json = json_encode($data, JSON_UNESCAPED_SLASHES);
$signature = hash_hmac("sha256", time() . $json, $API_KEY_SECRET);

:::

Webhook: проверка подписи

На ваш callback_url приходит POST.

Заголовки:

ЗаголовокОписание
X-SignatureHMAC-SHA256 hex
X-TimestampUnix timestamp

Данные для подписи:

{
  "params": "",
  "body": { }
}
  • params — query string вашего endpoint
  • body — распарсенное JSON тело POST
  • поле path не используется
  • для подписи используется callback_key

Допустимое отклонение timestamp: ±15 секунд.

Webhook депозита / вывода

В теле POST передаётся JSON-объект транзакции (поля описаны ниже). Для проверки подписи этот объект помещается в поле body, поле params оставляют пустым.

Webhook счёта (invoice)

{
  "params": "",
  "body": {
    "type": "invoice",
    "id": "5ca38db1-00c5-4aba-91e5-6a57bed60aee",
    "status": "executed"
  }
}

Тело POST совпадает с объектом подписи: на верхнем уровне поля params и body. Для проверки подписи используйте распарсенное тело запроса целиком, без дополнительной обёртки.

Python: проверка webhook

Webhook депозита и вывода:

body = await request.json()
data = {"params": request.url.query, "body": body}
verify(request.headers["X-Signature"], CALLBACK_KEY, int(request.headers["X-Timestamp"]), data)

Webhook счёта:

data = await request.json()
verify(request.headers["X-Signature"], CALLBACK_KEY, int(request.headers["X-Timestamp"]), data)

Общая функция verify:

def verify(signature: str, key: str, timestamp: int, data: dict) -> bool:
    if abs(int(time.time()) - timestamp) > 15:
        return False
    expected = sign(key, timestamp, data)
    return hmac.compare_digest(expected, signature)

Депозиты

Депозиты

Депозит регистрируется после on-chain перевода на адрес, полученный через API. Сканер блокчейна создаёт транзакцию с типом deposit.

Начало работы

Перед интеграцией создайте API key (раздел «Подпись»). Без ключа запросы к API не проходят.

Выбор типа интеграции

Доступны два способа приёма депозитов.

Счёт на оплату (Invoice)

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

Создание: POST /invoice/. Укажите сумму в фиате (target_value_fiat) или в крипте (target_value_symbol).

Символ и адрес

  • Если при создании указан symbol_id, сразу генерируется адрес и ссылка pay_url.
  • Если symbol_id не указан, плательщик выбирает символ и сеть на странице оплаты. Адрес появится после выбора.

Уведомления

СобытиеWebhook
Поступил on-chain переводWebhook депозита: сумма, hash, статус транзакции
Сумма по счёту набранаWebhook счёта: status: executed
Истёк срок счёта без полной оплатыWebhook счёта: status: expired

Статусы счёта: active, executed, expired, cancelled. Промежуточных статусов частичной оплаты (paid_over, wrong_amount и т.п.) нет. Частичные переводы приходят как отдельные webhook депозита; счёт переходит в executed, когда сумма депозитов достигает цели, или в expired по deadline_at.

Постоянный адрес

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

Создание: POST /user/address/. Укажите symbol_id и при необходимости external_id (ваш идентификатор адреса).

На адрес можно отправлять переводы любой суммы выше min_deposit_amount. Каждый перевод создаёт депозит и отдельный webhook.

Общий порядок

  1. Создайте счёт или постоянный адрес.
  2. Плательщик отправляет перевод on-chain.
  3. Сканер фиксирует депозит. Если указан callback_url, отправляется webhook.

Эндпоинты

МетодПутьОписание
POST/user/address/Постоянный адрес
GET/user/address/Список адресов
GET/user/address/balance/{symbol_id}/Последний адрес пополнения баланса по символу
POST/invoice/Счёт с адресом
GET/invoice/Список счетов
GET/invoice/my/{invoice_id}/Один счёт
GET/invoice/{invoice_id}/transactions/Депозиты по счёту
GET/user/transaction/История (type=deposit)
GET/user/transaction/{encoded_id}/Одна транзакция

POST /user/address/

Запрос

ПолеТипОписание
symbol_id*stringИдентификатор символа: валюта в конкретной сети, например USDTBEP20, BNBBEP20. Список значений: GET /symbol/ (раздел 4)
callback_urlstringURL для webhook депозита
descriptionstringМетка адреса
external_idstringВаш ID

Виртуальные символы (USDT) не принимаются. Указывайте символ с привязкой к сети.

Ответ

ПолеОписание
idID адреса
valueАдрес кошелька
symbol_idИдентификатор символа
callback_urlURL webhook
external_idВаш ID
created_atДата создания

POST /invoice/

Запрос

ПолеТипОписание
name*stringНазвание
symbol_idstringИдентификатор символа для оплаты
target_value_fiatdecimalСумма в фиате
target_currency_fiatstringФиат, по умолчанию USD
target_value_symboldecimalСумма в крипте
deadline_atdatetimeСрок счёта
callback_urlstringURL webhook статуса счёта
external_idstringВаш ID
is_payer_feeboolКомиссию платит плательщик
descriptionstringОписание

Нужно указать target_value_fiat или target_value_symbol.

Ответ

Адрес оплаты в target_wallet.value, текущий status, ссылка на оплату в pay_url.

GET /user/transaction/

Фильтры для депозитов:

ПараметрОписание
typedeposit
symbol_idИдентификатор символа
external_idВаш ID
statuspending, executed, dirty_lock, cancelled
in_processingtrue — только транзакции в обработке; false — завершённые
begin_at, end_atПериод

Webhook депозита

POST на callback_url, указанный при создании адреса. Для депозита по счёту используется callback_url счёта.

Тело (основные поля):

ПолеОписание
typedeposit
statusСтатус транзакции
symbol_idИдентификатор символа
amountСумма зачисления на баланс
service_feeКомиссия сервиса
net_amountСумма on-chain перевода (amount + service_fee)
blockchain_data.hashTx hash
blockchain_data.from_addressОтправитель
blockchain_data.to_addressПолучатель (ваш адрес)
external_idВаш ID из адреса
invoiceДанные счёта, если депозит по invoice
aml_orderСтатус AML, если проверка включена
callback_orderСтатус последней доставки webhook (last_status_code, last_response_data)

Пример

{
  "user_id": 1,
  "type": "deposit",
  "created_at": "2025-11-20T16:08:10.180830+00:00",
  "symbol_id": "USDTBEP20",
  "status": "executed",
  "amount": "4.696700000000000000",
  "service_fee": "0.803300000000000000",
  "net_amount": "5.500000000000000000",
  "blockchain_data": {
    "hash": "0xabc...",
    "from_address": "0x123",
    "to_address": "0x456"
  },
  "external_id": null,
  "callback_url": "https://example.com/cb"
}

Webhook счёта

Отдельный callback при смене статуса счёта (executed, expired). Формат тела и проверка подписи описаны в разделе «Webhook счёта (invoice)».

Статусы депозита

statusОписание
pendingОжидание AML или подтверждений сети
executedЗачислено на баланс
dirty_lockАдрес помечен dirty, депозит заблокирован
cancelledОтменён

Статусы счёта

statusОписание
activeОжидает оплаты
executedОплачен
expiredИстёк срок
cancelledОтменён

Доставка webhook

При неуспешном ответе вашего сервера webhook повторяется автоматически.

Если сервер уже ответил 2xx на первый webhook, повтор при смене статуса на executed не отправляется. При AML или ожидании подтверждений первый webhook может прийти со статусом pending.

Актуальный статус транзакции запрашивайте через GET /user/transaction/ или GET /user/transaction/{encoded_id}/.

Минимальная сумма

Депозиты ниже min_deposit_amount игнорируются. Актуальное значение: GET /setting/fees/ (раздел 4).

Выводы

Выводы

Эндпоинты

МетодПутьОписание
POST/user/balance/withdrawal/Создать вывод
GET/user/transaction/?type=withdrawalИстория и статус
GET/user/transaction/{encoded_id}/Одна транзакция

Отдельного GET /withdrawal/{id} нет. Используйте transaction API.

POST /user/balance/withdrawal/

Query

ПараметрОписание
totp_codeOTP из email. Не нужен при авторизации API key

Запрос

ПолеТипОписание
symbol_id*stringИдентификатор символа, например USDTTRC20. Список значений: GET /symbol/ (раздел 4)
to_address*stringАдрес получателя
amount*decimalСумма получателю (net)
external_idstringВаш ID
callback_urlstringURL webhook
extra.memostringMemo/tag (если сеть поддерживает)

Виртуальные символы не принимаются.

Комиссия списывается сверх amount. С баланса уходит amount + service_fee.

Ответ

JSON-объект транзакции: "type": "withdrawal", текущий статус вывода в status, идентификатор в encoded_id.

Ошибки

detailПричина
Insufficient balanceНедостаточно средств
Invalid addressНеверный адрес
Minimum withdrawal amount is ...Ниже минимума
TOTP code is requiredНужен totp_code без API key
MEMO doesn't supported on this chain!Memo не поддерживается

Rate limit: 15 запросов за 15 секунд.

GET /user/transaction/

ПараметрОписание
typewithdrawal
statusСтатус вывода
in_processingtrue — только выводы в обработке
external_idВаш ID

Webhook вывода

Отправляется один раз при переходе вывода в статус executed.

Тело

JSON-объект транзакции с "type": "withdrawal". Поля совпадают с объектом в webhook депозита.

ПолеОписание
amountСумма транзакции (получатель + комиссия)
service_feeКомиссия
net_amountСумма получателю (amount - service_fee)
statusexecuted
blockchain_data.hashTx hash
to_addressАдрес получателя
memoMemo, если был
external_idВаш ID

Подпись проверяется ключом callback_key по заголовкам X-Signature, X-Timestamp и структуре данных с полями params и body.

Статусы вывода

statusОписание
compliance_approve_requiredОжидает ручного одобрения
createdВ очереди
aml_order_pendingAML проверка
prepare_pendingПодготовка транзакции
ready_to_transferГотов к отправке
transfer_lockОтправка в сеть
pendingОжидание подтверждений
swap_lockОжидание autoswap
executedВыполнен
cancelledОтменён админом
cancelled_by_riskОтменён по AML
failedОшибка

Фильтр in_processing=true возвращает все статусы, кроме executed, cancelled, cancelled_by_risk, failed.

Ограничения

ПараметрОписание
min_withdrawal_amountМинимум по символу и тарифу. Значение: GET /setting/fees/
withdrawal_fee_amountФиксированная комиссия
withdrawal_fee_percentageПроцент комиссии
totp_codeОбязателен без API key (email OTP, 10 мин)

Повтор запроса с тем же external_id не является идемпотентным.

Справочные эндпоинты

Справочные эндпоинты

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

Эндпоинты

МетодПутьОписание
GET/symbol/Список символов
GET/symbol/fiat/Список поддерживаемых фиатных валют
GET/user/balance/Баланс по символам
GET/setting/fees/Комиссии и лимиты
GET/currency/rate/Курсы валютных пар
GET/currency/rate/hedge/Курсы к USDT (источник aster_dex)

GET /symbol/

Используйте для получения допустимых значений symbol_id при создании адреса, счёта или вывода.

Query

ПараметрОписание
pageНомер страницы, по умолчанию 1
per_pageРазмер страницы, по умолчанию 100
search_queryПоиск по id, name, short_name
order_typesymbol, short_name, name
order_ascСортировка по возрастанию, по умолчанию true

Ответ

Пагинированный список. Каждый элемент:

ПолеОписание
idИдентификатор символа для API (symbol_id)
nameПолное название
short_nameКраткое название валюты
blockchainСеть: id, name, ссылки на explorer
is_activeДоступен ли символ
is_virtualВиртуальный символ (для API не используйте)
group_symbol_idГруппа баланса, если символ сгруппирован
balance_symbol_idСимвол, по которому ведётся баланс
contract_addressАдрес контракта токена, если есть
precisionТочность

Для запросов с symbol_id выбирайте записи с is_virtual: false и is_active: true.

GET /symbol/fiat/

Список кодов фиатных валют для поля target_currency_fiat при создании счёта.

Ответ

Массив строк, например ["USD", "EUR", ...].

GET /user/balance/

Текущий баланс аккаунта. Удобно перед созданием вывода.

Query

ПараметрОписание
search_queryФильтр по symbol_id

Ответ

Массив объектов:

ПолеОписание
symbol_idИдентификатор символа
valueДоступный баланс

Rate limit: 30 запросов в минуту.

GET /setting/fees/

Комиссии и минимальные суммы по символам.

Query

ПараметрОписание
user_idID пользователя для персональных настроек
tariff_idID тарифа

Без параметров возвращаются глобальные значения. Передайте свой user_id, чтобы получить актуальные лимиты и комиссии.

Ответ

Массив объектов по символам:

ПолеОписание
symbol_idИдентификатор символа
min_deposit_amountМинимальный депозит
min_withdrawal_amountМинимальный вывод
deposit_fee_amountФиксированная комиссия депозита
deposit_fee_percentageПроцент комиссии депозита
withdrawal_fee_amountФиксированная комиссия вывода
withdrawal_fee_percentageПроцент комиссии вывода

GET /currency/rate/

Курсы валютных пар.

Query

ПараметрОписание
sourceИсточник: coingecko или aster_dex. Без параметра — все источники

Ответ

Массив объектов:

ПолеОписание
from_symbol_idsymbol_id криптовалюты или код фиата (для пар фиат→фиат)
to_symbol_nameКод валюты котировки: фиат (USD, EUR, ...) или USDT
valueКурс: сколько единиц to_symbol_name за 1 единицу from_symbol_id
sourcecoingecko или aster_dex
created_atВремя обновления

Примеры пар

sourcefrom_symbol_idto_symbol_nameСмысл
coingeckoUSDTBEP20USDКриптосимвол к фиату
coingeckoUSDEURФиат к фиату
aster_dexBTCUSDTКриптосимвол к USDT

GET /currency/rate/hedge/

Только курсы from_symbol_idUSDT из источника aster_dex. Формат ответа совпадает с GET /currency/rate/.

Интеграция с ИИ

Интеграция с помощью ИИ

Документация Cryptoway собрана так, чтобы её можно было целиком отдать ИИ-ассистенту — ChatGPT, Claude, Gemini, Cursor, Copilot или любому другому. Он прочитает спецификацию и напишет рабочую интеграцию на PHP, Node.js, Python, Go или Rust за минуты, а не за часы.

Одна ссылка для ассистента

Вся документация, полная спецификация API и бренд-гайд собраны в один файл на английском — ИИ-модели работают с ним точнее всего.

:::copy https://docs.cryptoway.com/llms-full.txt | Скопировать ссылку | Ссылка скопирована

Скопируйте ссылку, отдайте её ассистенту и опишите задачу: на каком языке и что именно нужно интегрировать. Если ассистент не умеет ходить в интернет, откройте файл по этой ссылке и вставьте его содержимое в чат целиком.

Файл пересобирается вместе с документацией, поэтому разойтись с ней не может. Отдельно доступна спецификация openapi.json.

Готовый промпт

Полная документация платёжного API Cryptoway: https://docs.cryptoway.com/llms-full.txt
Прочитай её целиком, прежде чем писать код.

Задача: напиши интеграцию на <язык или фреймворк>, которая
1) создаёт счёт на оплату,
2) проверяет подпись входящего webhook,
3) обрабатывает статусы платежа.

Требования:
- строго следуй схеме подписи HMAC-SHA256 из раздела «Подпись»;
- используй только те эндпоинты и поля, что есть в документации, ничего не придумывай;
- ключи читай из переменных окружения, не зашивай в код;
- добавь обработку ошибок и повторные попытки на приёме webhook.

Что проверить за ассистентом

Подпись. Самое частое место, где ИИ ошибается, — порядок полей и кодирование при формировании строки для HMAC-SHA256. Сверьте результат с разделом Подпись.

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

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

Суммы. Криптовалютные суммы нужно считать в строках или decimal, не в числах с плавающей точкой.

Боевые ключи. Проверяйте сгенерированный код на тестовом проекте, прежде чем подключать боевые ключи.

Premium Exchange

Как подключить к Premium Exchanger

Подключение Cryptoway к обменному пункту на скрипте Premium Exchanger (v 2.7) — двумя модулями:

  • Мерчант (приём средств) — принимает средства от клиента на ваши счета и автоматически переводит заявку в статус «Оплаченная заявка».
  • Автовыплата — выплачивает средства клиенту с ваших счетов.

Вместе они дают полную автоматизацию обмена. Можно подключить только один модуль — тогда автоматизируется только приём или только выплата.

Полная документация Premium Exchanger: Модули мерчантов и автовыплат

Что понадобится

  • Обменник на Premium Exchanger 2.7.x. Модули несовместимы между версиями: на скрипте 2.7 нужны модули 2.7.*, иначе сайт не откроется.
  • Доступ к серверу через ISP Manager из-под пользователя сайта (не root).
  • Ключи Cryptoway с разрешениями на депозиты и выводы — Project ID и secret (см. Подпись).

Шаг 1. Файлы модулей

МодульАрхивНазначение
Мерчант (приём средств)m_cryptoway_271.zipПриём криптоплатежей
Автовыплатыpay_cryptoway_271.zipАвтоматические выплаты

Версия модуля должна совпадать с версией вашего скрипта Premium Exchanger (например, 271 — под 2.7.\*).

Шаг 2. Загрузка на сервер

Перед изменением файлов сделайте бэкап корневой папки сайта. Работайте через ISP Manager из-под пользователя сайта (не root).

  1. Папку cryptoway из m_cryptoway_271.zip загрузите в /wp-content/plugins/premiumbox/merchants.
  2. Папку cryptoway из pay_cryptoway_271.zip загрузите в /wp-content/plugins/premiumbox/paymerchants.
  3. При окне о совпадении файлов — нажмите «Заменить».

Шаг 3. Добавление и настройка мерчанта

В разделе «Мерчанты» → «Мерчанты» нажмите «Добавить» (часть мерчантов создана по умолчанию). Заполните форму:

Форма добавления мерчанта в Premium Exchanger

  • Заголовок — название мерчанта в панели управления.
  • Модуль — выберите Cryptoway из выпадающего списка.
  • Статус«активный мерчант».

В настройках модуля укажите ключи из личного кабинета Cryptoway:

  • API ключ — сюда вставьте Project ID из кабинета Cryptoway.
  • Секретный ключsecret вашего API-ключа.

Шаг 4. Автовыплаты

Модуль автовыплат подключается так же: раздел «Автовыплаты»«Добавить», статус «активный», те же ключи Cryptoway (Project ID + secret). Привязывается на вкладке «Мерчанты и выплаты» направления — для валюты «Получаю». Перед включением ознакомьтесь с разделом «Предупреждение о рисках» в документации Premium Exchanger.

Шаг 5. Режимы работы

Изначально обменник работает в ручном режиме. С модулями:

  • Только мерчант на приём — автоматизируется приём: при поступлении средств заявка переходит в «Оплаченная заявка», выплату вы делаете вручную и меняете статус на «Выполненная заявка».
  • Мерчант + автовыплата — полная автоматизация: «Оплаченная заявка» → «Ожидание подтверждения от модуля автовыплат» → «Выполненная заявка».
  • Можно включить кнопку «Перевести» в заявке даже для автоматизированного направления — оператор сможет выплатить вручную, если автовыплата не прошла.

Шаг 6. Проверка

Проверьте подключение встроенной «Диагностикой мерчанта» (Мерчанты → Мерчанты → диагностика):

Лог и диагностика мерчантов в Premium Exchanger

  • Убедитесь, что на сервере настроен планировщик задач (cron) — без него статусы заявок не меняются автоматически.
  • Если в логе ошибка вида «your IP … not in whitelist» — добавьте IP вашего сервера в whitelist API-ключа Cryptoway (параметр allowed_ips).

iEXExchanger

Как подключить к iEXExchanger

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

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

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

Важно. Перед включением мерчанта в рабочем направлении обязательно выполните тестовую оплату на небольшую сумму. Если неправильно указать API-ключ, Callback Key или сеть, адрес для оплаты может не создаться, а автоматическая обработка платежей работать не будет.

Полная документация iEXExchanger: Мерчант Cryptoway.

Что понадобится

Перед настройкой подготовьте данные из личного кабинета Cryptoway:

  • Project ID
  • Secret key

В модуле iEXExchanger эти поля называются по-старому — API Key ID и API Key Secret.

Для приёма криптовалюты API-ключ должен иметь разрешение Deposits. Разрешение Withdrawal предназначено для автоматических выплат — для работы мерчанта на приём оно не требуется (см. Подпись и Депозиты).

Шаг 1. Регистрация и API-ключ в Cryptoway

Создайте аккаунт или войдите в существующий на cryptoway.com. После входа:

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

Важно. Key Secret показывается только при создании ключа — повторно посмотреть его не получится. Если ключ не был сохранён, создайте новую пару ключей. Сохраните данные в безопасном месте и не передавайте их третьим лицам.

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

Шаг 2. Добавление мерчанта

В админке iEXExchanger откройте «Мерчанты и API» → «Список мерчантов» и нажмите «Добавить». В списке модулей выберите Cryptoway.

Шаг 3. Настройка мерчанта

Заполните поля мерчанта:

  • API Key ID — сюда вставьте Project ID из кабинета Cryptoway (формат xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). Поле в модуле называется по-старому. Обязательное поле.
  • API Key Secret — секретная часть API-ключа. Используется для подписи запросов создания адресов оплаты, проверки поступления средств и получения списка доступных валют и сетей. Обязательное поле, без пробелов в начале и конце значения.
  • API Base URL — оставьте стандартное значение https://api.cryptoway.com. Изменяйте только по рекомендации техподдержки Cryptoway; не указывайте здесь адрес личного кабинета или домен вашего обменного пункта.
  • Callback Key — оставьте поле пустым.

Код валюты. Выберите код валюты и блокчейн-сети, который используется в Cryptoway, например USDTTRC20, USDTBEP20 или BNBBEP20. Использовать общий код без сети (например USDT) нельзя — Cryptoway принимает код, привязанный к конкретной блокчейн-сети. Если выбрано значение «Автоматически», система берёт код сети из настроек валюты; заранее убедитесь, что он совпадает с идентификатором валюты в Cryptoway.

Макс. время регистрации в блокчейне — задаётся в минутах, рекомендуемое значение 30. В течение этого времени система ожидает регистрацию транзакции в блокчейне.

Макс. время получения первого подтверждения — задаётся в часах, рекомендуемое значение 2. В течение этого времени система ожидает первое подтверждение транзакции.

Шаг 4. Привязка мерчанта к валюте

После сохранения мерчанта назначьте его нужной валюте. Откройте «Основное» → «Валюты» → «Список валют», выберите валюту, перейдите в раздел автоматизации и в качестве мерчанта выберите Cryptoway.

Убедитесь, что выбранная сеть соответствует сети, указанной в настройках мерчанта. Например:

  • Валюта: USDT
  • Сеть: TRC20
  • Код Cryptoway: USDTTRC20
  • Мерчант: Cryptoway

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

Как работает приём платежей

После создания заявки iEXExchanger автоматически отправляет запрос в API Cryptoway. Cryptoway создаёт постоянный адрес и возвращает его системе, клиент переводит средства на этот адрес. Когда платёж получает статус executed, iEXExchanger автоматически переводит заявку в следующий статус. Для связи платежа с заявкой iEXExchanger передаёт в Cryptoway идентификатор заявки.

Фактически поступившая сумма считается по значению amount — это сумма, зачисленная на баланс Cryptoway после учёта комиссии сервиса. Учитывайте комиссию Cryptoway при настройке направления обмена: сумма перевода в блокчейне может отличаться от суммы, фактически зачисленной на баланс.

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

  • поля API Key ID и API Key Secret заполнены правильно — в них Project ID и Secret key из кабинета;
  • для API-ключа включено разрешение Deposits;
  • API Base URL имеет значение https://api.cryptoway.com;
  • код валюты и сеть указаны без ошибок, не используется код без сети (например USDT);
  • backend обменника доступен по HTTPS;
  • публичный IP сервера разрешён в настройках API-ключа;
  • мерчант привязан к нужной валюте или направлению;
  • учтены минимальная сумма и комиссия Cryptoway;
  • на время тестирования включено логирование запросов.

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

  1. Создайте тестовую заявку.
  2. Убедитесь, что появился адрес оплаты.
  3. Проверьте, что адрес соответствует выбранной сети.
  4. Отправьте небольшую сумму.
  5. Дождитесь обработки платежа.
  6. Проверьте изменение статуса заявки.
  7. Убедитесь, что платёж получил статус executed.
  8. Проверьте сохранение хеша транзакции.
  9. Сверьте сумму заявки с суммой, зачисленной на баланс Cryptoway.
  10. Проверьте журнал запросов: «Журнал событий» → «Мерчанты и API» → «Лог запросов мерчантов».

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

  • Используйте отдельный API-ключ Cryptoway для каждого обменного пункта.
  • Для приёма и автоматических выплат используйте разные API-ключи.
  • Не публикуйте API Key ID и API Key Secret в переписках и на скриншотах.
  • Перед включением мерчанта в рабочих направлениях всегда выполняйте тестовую оплату.
  • Проверяйте актуальную минимальную сумму депозита и комиссию для выбранной валюты.
  • После успешной проверки можно отключить расширенное логирование запросов.

WooCommerce

Плагин Cryptoway для WooCommerce

Плагин добавляет приём криптовалюты в WooCommerce. Покупатель оформляет заказ в обычной кассе магазина, оплачивает счёт на странице Cryptoway и возвращается на страницу подтверждения, а статус заказа обновляется сам.

Что понадобится

  • WordPress 6.9 или новее;
  • PHP 8.1 или новее;
  • WooCommerce 9.0 или новее;
  • аккаунт Cryptoway с активным проектом.

Плагин поддерживает блочную кассу WooCommerce и новое хранилище заказов (HPOS).

Получите доступ

  1. Зарегистрируйтесь в личном кабинете Cryptoway.
  2. Откройте раздел Projects и нажмите New project.
  3. Заполните заявку: название проекта, адрес сайта и контакт для связи.
  4. Дождитесь статуса Active — заявку проверяет менеджер, обычно в течение одного рабочего дня. До проверки проект показан как In review.
  5. На странице проекта нажмите API keys.
  6. Скопируйте Project ID, Callback key и Secret key.

Важно. Ключи проекта работают только с того адреса, с которого их использовали впервые. Заведите каждому магазину отдельный проект.

Установка

Через каталог WordPress
  1. Откройте Плагины → Добавить новый.
  2. Найдите Cryptoway.
  3. Установите и активируйте плагин.
Загрузкой архива
  1. Откройте Плагины → Добавить новый → Загрузить плагин.
  2. Выберите архив плагина и нажмите Установить.
  3. Активируйте плагин.
Вручную

Загрузите папку плагина в каталог /wp-content/plugins/ и активируйте плагин в разделе Плагины.

Убедитесь, что WooCommerce установлен и активен.

Настройка способа оплаты

Откройте WooCommerce → Настройки → Платежи → Cryptoway.

ПолеЗначение
Способ оплатыВключает оплату через Cryptoway.
Название при оформленииНазвание способа оплаты в кассе.
Текст под названиемОдна строка, которую видит покупатель. Можно оставить пустым.
Другие языкиНазвание и текст для других языков сайта.
Project IDПервое значение из окна Project credentials.
Callback keyВторое значение. Оставьте пустым — плагин получит его при сохранении.
Secret keyТретье значение.
Сколько времени на оплатуОт 15 до 1440 минут. По умолчанию — 60. На это время фиксируется курс.
Минимальный заказНиже этой суммы способ оплаты не показывается. Ноль — без ограничения.
Максимальный заказВыше этой суммы способ оплаты не показывается. Ноль — без ограничения.
Если покупатель не успел оплатитьЗакрыть заказ или оставить его доступным для оплаты позже.
Тестовый режимЗаказы не отправляются в Cryptoway. Выключите перед началом продаж.
Подробный журналВключайте на время настройки. Журнал: WooCommerce → Статус → Логи.

Сохраните изменения.

Настройка проекта

Остальное настраивается в кабинете Cryptoway: откройте проект и перейдите на вкладку Настройки.

РазделЧто задаёт
Автоконвертация при поступленииАвтоконвертация поступающих активов в выбранную валюту.
Оформление платёжной страницыЦвет, логотип и тема страницы, на которой платит покупатель.
Макет платёжной страницыВид счёта: в одну колонку или в две.
Информация о проектеРеквизиты получателя. Печатаются на счёте.
Комиссия и наценкаКто платит комиссию Cryptoway и нужна ли наценка к сумме счёта.
Разрешённые IPАдреса серверов, которым разрешено обращаться к API проекта.

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

Как проходит оплата

  1. Покупатель выбирает Cryptoway при оформлении заказа.
  2. Плагин создаёт счёт на сумму заказа и отправляет покупателя на страницу оплаты Cryptoway.
  3. Покупатель выбирает монету и сеть и переводит сумму.
  4. Плагин сверяет сумму и валюту с заказом и переводит заказ в оплаченные.
  5. Покупатель возвращается на страницу подтверждения заказа.

Обычно от оплаты до смены статуса проходят секунды. Если уведомление не дошло, плагин перепроверяет счёт сам в течение десяти минут.

Статусы заказа

Что произошлоЧто делает плагин
Оплачено полностьюПереводит заказ в «Обработка» и записывает в историю сумму и монету.
Пришло меньше суммы заказаСтавит заказ на удержание и отмечает, что нужна проверка. Заказ не отгружается.
Пришло больше суммы заказаЗаказ оплачен, разница отмечена в истории.
Время на оплату вышлоОтменяет заказ или оставляет его доступным для оплаты — по настройке.
Оплата отмененаОтменяет заказ.
Платёж задержан проверкой безопасностиСтавит заказ на удержание до решения на стороне Cryptoway.
Деньги пришли по уже отменённому заказуСтавит заказ на удержание и предупреждает в истории: товар мог вернуться на склад.

Заказ считается оплаченным только после сверки суммы и валюты. Недоплаченный заказ не отгружается автоматически.

Проверка после настройки

  1. Создайте заказ на небольшую сумму.
  2. Выберите Cryptoway при оформлении.
  3. Убедитесь, что открылась страница оплаты Cryptoway.
  4. Оплатите счёт.
  5. Проверьте, что заказ перешёл в «Обработка», а в его карточке появились номер платежа, монета и хеш транзакции.

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

Диагностика

ПроблемаЧто проверить
Cryptoway не появляется при оформленииПлагин активен, способ оплаты включён, заполнены Project ID и Secret key, сумма заказа попадает в заданные границы.
Страница оплаты не открываетсяПроект имеет статус Active, ключи скопированы из окна Project credentials без лишних пробелов.
Заказ не обновился после оплатыЗаполнен Callback key. Откройте карточку заказа и нажмите проверку статуса платежа.
Cryptoway отказывает в доступеКлючи привязаны к адресу сервера, с которого их использовали впервые. Заведите магазину отдельный проект или очистите список в разделе «Разрешённые IP».
Нужны детали запросовВключите подробный журнал и повторите заказ: WooCommerce → Статус → Логи.

Тарифы и список монет — на сайте Cryptoway. Поддержка: @cryptoway_support_bot.

Easy Digital Downloads

Плагин Cryptoway для Easy Digital Downloads

Плагин добавляет приём криптовалюты в Easy Digital Downloads. Покупатель оформляет заказ в обычной кассе магазина, оплачивает счёт на странице Cryptoway и возвращается на страницу подтверждения, а статус заказа обновляется сам.

Что понадобится

  • WordPress 6.9 или новее;
  • PHP 8.1 или новее;
  • Easy Digital Downloads 3.2 или новее;
  • аккаунт Cryptoway с активным проектом.

Получите доступ

  1. Зарегистрируйтесь в личном кабинете Cryptoway.
  2. Откройте раздел Projects и нажмите New project.
  3. Заполните заявку: название проекта, адрес сайта и контакт для связи.
  4. Дождитесь статуса Active — заявку проверяет менеджер, обычно в течение одного рабочего дня. До проверки проект показан как In review.
  5. На странице проекта нажмите API keys.
  6. Скопируйте Project ID, Callback key и Secret key.

Важно. Ключи проекта работают только с того адреса, с которого их использовали впервые. Заведите каждому магазину отдельный проект.

Установка

Через каталог WordPress
  1. Откройте Плагины → Добавить новый.
  2. Найдите Cryptoway.
  3. Установите и активируйте плагин.
Загрузкой архива
  1. Откройте Плагины → Добавить новый → Загрузить плагин.
  2. Выберите архив плагина и нажмите Установить.
  3. Активируйте плагин.
Вручную

Загрузите папку плагина в каталог /wp-content/plugins/ и активируйте плагин в разделе Плагины.

Убедитесь, что Easy Digital Downloads установлен и активен.

Настройка способа оплаты

  1. Откройте Загрузки → Настройки → Платежи.
  2. Включите Cryptoway в списке способов оплаты.
  3. Перейдите в раздел Cryptoway и заполните поля.
ПолеЗначение
Название при оформленииНазвание способа оплаты в кассе.
Текст под названиемОдна строка, которую видит покупатель. Можно оставить пустым.
Другие языкиНазвание и текст для других языков сайта.
Project IDПервое значение из окна Project credentials.
Callback keyВторое значение. Оставьте пустым — плагин получит его при сохранении.
Secret keyТретье значение.
Время на оплатуОт 15 до 1440 минут. По умолчанию — 60. На это время фиксируется курс.
Минимальный заказНиже этой суммы способ оплаты не показывается. Ноль — без ограничения.
Максимальный заказВыше этой суммы способ оплаты не показывается. Ноль — без ограничения.
Подробный журналВключайте на время настройки.

Сохраните изменения.

Важно. Тестовый режим в Easy Digital Downloads общий для всех способов оплаты: Загрузки → Настройки → Платежи → Тестовый режим. Пока он включён, заказы не отправляются в Cryptoway.

Настройка проекта

Остальное настраивается в кабинете Cryptoway: откройте проект и перейдите на вкладку Настройки.

РазделЧто задаёт
Автоконвертация при поступленииАвтоконвертация поступающих активов в выбранную валюту.
Оформление платёжной страницыЦвет, логотип и тема страницы, на которой платит покупатель.
Макет платёжной страницыВид счёта: в одну колонку или в две.
Информация о проектеРеквизиты получателя. Печатаются на счёте.
Комиссия и наценкаКто платит комиссию Cryptoway и нужна ли наценка к сумме счёта.
Разрешённые IPАдреса серверов, которым разрешено обращаться к API проекта.

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

Как проходит оплата

  1. Покупатель выбирает Cryptoway при оформлении заказа.
  2. Плагин создаёт счёт на сумму заказа и отправляет покупателя на страницу оплаты Cryptoway.
  3. Покупатель выбирает монету и сеть и переводит сумму.
  4. Плагин сверяет сумму и валюту с заказом и переводит заказ в оплаченные.
  5. Покупатель возвращается на страницу подтверждения заказа.

Обычно от оплаты до смены статуса проходят секунды. Если уведомление не дошло, плагин перепроверяет счёт сам в течение десяти минут.

Статусы заказа

Что произошлоЧто делает плагин
Оплачено полностьюПереводит заказ в «Завершён» и записывает в историю сумму и монету.
Пришло меньше суммы заказаСтавит заказ в «Приостановлен» и отмечает, что нужна проверка. Доступ к файлам не выдаётся.
Пришло больше суммы заказаЗаказ оплачен, разница отмечена в истории.
Время на оплату вышлоЗакрывает заказ как неоплаченный.
Оплата отмененаЗакрывает заказ как неоплаченный.
Платёж задержан проверкой безопасностиСтавит заказ в «Приостановлен» до решения на стороне Cryptoway.
Деньги пришли по уже закрытому заказуСтавит заказ в «Приостановлен» и предупреждает в истории.

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

Проверка после настройки

  1. Создайте заказ на небольшую сумму.
  2. Выберите Cryptoway при оформлении.
  3. Убедитесь, что открылась страница оплаты Cryptoway.
  4. Оплатите счёт.
  5. Проверьте, что заказ перешёл в «Завершён», а в его карточке появились номер платежа, монета и хеш транзакции.

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

Диагностика

ПроблемаЧто проверить
Cryptoway не появляется при оформленииПлагин активен, шлюз включён в списке способов оплаты, заполнены Project ID и Secret key, сумма заказа попадает в заданные границы.
Страница оплаты не открываетсяПроект имеет статус Active, ключи скопированы из окна Project credentials без лишних пробелов.
Заказ не обновился после оплатыЗаполнен Callback key. Откройте карточку заказа и нажмите проверку статуса платежа.
Cryptoway отказывает в доступеКлючи привязаны к адресу сервера, с которого их использовали впервые. Заведите магазину отдельный проект или очистите список в разделе «Разрешённые IP».
Нужны детали запросовВключите подробный журнал и повторите заказ.

Тарифы и список монет — на сайте Cryptoway. Поддержка: @cryptoway_support_bot.

Introduction

API Integration

Endpoint: https://api.cryptoway.com

The Cryptoway API is signed with HMAC-SHA256. The documentation is split into four sections:

Signing

Signing

Keys

KeyWhere to find itPurpose
Project ID + secretDashboard → API keysSigning API requests
callback_keyDashboard → profileVerifying webhooks

For webhooks, use callback_key — not the secret API key.

Getting API keys

A single API key works for every API method, as long as you enable the permissions it needs when you create it.

Key creation parameters

ParameterDescription
descriptionKey name
allowed_ipsList of allowed IPs. Can be left empty
is_deposit_allowedAllow deposit operations
is_withdrawal_allowedAllow withdrawals

If allowed_ips is empty, the first successful API request automatically adds the current IP to the list.

Steps

  1. Sign up for the service.
  2. Open the API keys tab.
  3. Click Create API key.
  4. Set the name, permissions, and IPs in the form.
  5. Copy the keys from the modal right away — the secret is shown only once.
  6. Done.

In your requests, use the Project ID as X-API-Key-ID and the secret for signing. The header name has not changed: the dashboard calls the value Project ID, and it travels in X-API-Key-ID.

callback_key

The webhook verification key lives in your dashboard profile. It is not the same as the secret API key.

Request headers

HeaderDescription
X-API-Key-IDProject ID (UUID)
X-TimestampUnix timestamp, seconds
X-SignatureHMAC-SHA256 hex

A signature is required for every public endpoint (GET, POST, and others).

Signing algorithm

  1. Build the object:
{
  "params": "url_encoded_query_string",
  "body": {},
  "path": "/user/balance/"
}
  • params — the query string exactly as it appears in the URL (search_query=foo, without the ?)
  • body — the JSON request body; {} when there is no body
  • path — the request path, e.g. /user/balance/
  1. Serialize the object: json.dumps(data, separators=(",", ":"), sort_keys=True)
  2. Sign it:
signature = HMAC-SHA256(key=API_KEY_SECRET, message=timestamp + json_string)
  1. The timestamp must be within ±15 seconds of server time.

If the key's allowlist is empty, the first successful request records the current IP in the allowlist. After that, only requests from a listed IP are accepted.

Example: GET balance

# empty params, body {}
# path = /user/balance/
# data = {"body":{},"params":"","path":"/user/balance/"}

curl "https://api.cryptoway.com/user/balance/" \
  -H "X-API-Key-ID: <PROJECT_ID>" \
  -H "X-Timestamp: 1718659200" \
  -H "X-Signature: <hex>"

Example: POST address

curl "https://api.cryptoway.com/user/address/" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key-ID: <PROJECT_ID>" \
  -H "X-Timestamp: 1718659200" \
  -H "X-Signature: <hex>" \
  -d '{"symbol_id":"USDTBEP20","callback_url":"https://example.com/cb","description":"shop"}'

Generating a signature

:::tabs

import hashlib, hmac, json, time

def sign(key: str, timestamp: int, data: dict) -> str:
    s = json.dumps(data, separators=(",", ":"), sort_keys=True)
    return hmac.new(key.encode(), f"{timestamp}{s}".encode(), hashlib.sha256).hexdigest()

data = {"params": "", "body": {"symbol_id": "USDTBEP20"}, "path": "/user/address/"}
ts = int(time.time())
signature = sign(API_KEY_SECRET, ts, data)
$data = ["params" => "", "body" => ["symbol_id" => "USDTBEP20"], "path" => "/user/address/"];
ksort($data);
$json = json_encode($data, JSON_UNESCAPED_SLASHES);
$signature = hash_hmac("sha256", time() . $json, $API_KEY_SECRET);

:::

Verifying a webhook signature

A POST is sent to your callback_url.

Headers:

HeaderDescription
X-SignatureHMAC-SHA256 hex
X-TimestampUnix timestamp

Data to sign:

{
  "params": "",
  "body": { }
}
  • params — the query string of your endpoint
  • body — the parsed JSON POST body
  • the path field is not used
  • the signature uses callback_key

Allowed timestamp drift: ±15 seconds.

Deposit / withdrawal webhook

The POST body is the transaction object as JSON (fields are described below). To verify the signature, place this object in the body field and leave params empty.

Invoice webhook

{
  "params": "",
  "body": {
    "type": "invoice",
    "id": "5ca38db1-00c5-4aba-91e5-6a57bed60aee",
    "status": "executed"
  }
}

The POST body is identical to the object you sign: params and body at the top level. To verify the signature, use the entire parsed request body as-is, with no extra wrapper.

Verifying webhooks in Python

Deposit and withdrawal webhooks:

body = await request.json()
data = {"params": request.url.query, "body": body}
verify(request.headers["X-Signature"], CALLBACK_KEY, int(request.headers["X-Timestamp"]), data)

Invoice webhook:

data = await request.json()
verify(request.headers["X-Signature"], CALLBACK_KEY, int(request.headers["X-Timestamp"]), data)

Shared verify helper:

def verify(signature: str, key: str, timestamp: int, data: dict) -> bool:
    if abs(int(time.time()) - timestamp) > 15:
        return False
    expected = sign(key, timestamp, data)
    return hmac.compare_digest(expected, signature)

Deposits

Deposits

A deposit is registered after an on-chain transfer to an address you obtained through the API. The blockchain scanner creates a transaction with the deposit type.

Getting started

Before you integrate, create an API key (see the Signing section). Without a key, API requests won't go through.

Choosing an integration type

There are two ways to accept deposits.

Invoice

Best for charging a fixed amount for a product or service.

Create one with POST /invoice/. Set the amount in fiat (target_value_fiat) or in crypto (target_value_symbol).

Symbol and address

  • If you pass symbol_id at creation, an address and a pay_url are generated right away.
  • If you omit symbol_id, the payer picks the symbol and network on the payment page. The address appears once they choose.

Notifications

EventWebhook
On-chain transfer receivedDeposit webhook: amount, hash, transaction status
Invoice amount collectedInvoice webhook: status: executed
Invoice expired before full paymentInvoice webhook: status: expired

Invoice statuses: active, executed, expired, cancelled. There are no intermediate partial-payment statuses (paid_over, wrong_amount, etc.). Partial transfers arrive as separate deposit webhooks; the invoice moves to executed once the deposits add up to the target, or to expired at deadline_at.

Permanent address

Best for topping up a balance with no fixed amount.

Create one with POST /user/address/. Pass symbol_id and, optionally, external_id (your own identifier for the address).

You can send transfers of any amount above min_deposit_amount to the address. Each transfer creates a deposit and its own webhook.

Overall flow

  1. Create an invoice or a permanent address.
  2. The payer sends an on-chain transfer.
  3. The scanner registers the deposit. If a callback_url is set, a webhook is sent.

Endpoints

MethodPathDescription
POST/user/address/Permanent address
GET/user/address/List of addresses
GET/user/address/balance/{symbol_id}/Latest balance top-up address for a symbol
POST/invoice/Invoice with an address
GET/invoice/List of invoices
GET/invoice/my/{invoice_id}/A single invoice
GET/invoice/{invoice_id}/transactions/Deposits for an invoice
GET/user/transaction/History (type=deposit)
GET/user/transaction/{encoded_id}/A single transaction

POST /user/address/

Request

FieldTypeDescription
symbol_id*stringSymbol identifier: a currency on a specific network, e.g. USDTBEP20, BNBBEP20. For the list of values, see GET /symbol/ (Reference)
callback_urlstringURL for the deposit webhook
descriptionstringAddress label
external_idstringYour ID

Virtual symbols (USDT) are not accepted. Always pass a network-bound symbol.

Response

FieldDescription
idAddress ID
valueWallet address
symbol_idSymbol identifier
callback_urlWebhook URL
external_idYour ID
created_atCreation date

POST /invoice/

Request

FieldTypeDescription
name*stringName
symbol_idstringSymbol identifier for the payment
target_value_fiatdecimalAmount in fiat
target_currency_fiatstringFiat currency, USD by default
target_value_symboldecimalAmount in crypto
deadline_atdatetimeInvoice expiry
callback_urlstringURL for the invoice status webhook
external_idstringYour ID
is_payer_feeboolThe payer covers the fee
descriptionstringDescription

You must set either target_value_fiat or target_value_symbol.

Response

The payment address is in target_wallet.value, the current status, and the payment link in pay_url.

GET /user/transaction/

Filters for deposits:

ParameterDescription
typedeposit
symbol_idSymbol identifier
external_idYour ID
statuspending, executed, dirty_lock, cancelled
in_processingtrue — in-progress transactions only; false — completed
begin_at, end_atDate range

Deposit webhook

A POST to the callback_url you set when creating the address. For invoice deposits, the invoice's callback_url is used.

Body (main fields):

FieldDescription
typedeposit
statusTransaction status
symbol_idSymbol identifier
amountAmount credited to the balance
service_feeService fee
net_amountOn-chain transfer amount (amount + service_fee)
blockchain_data.hashTx hash
blockchain_data.from_addressSender
blockchain_data.to_addressRecipient (your address)
external_idYour ID from the address
invoiceInvoice data, if the deposit is for an invoice
aml_orderAML status, if the check is enabled
callback_orderStatus of the latest webhook delivery (last_status_code, last_response_data)

Example

{
  "user_id": 1,
  "type": "deposit",
  "created_at": "2025-11-20T16:08:10.180830+00:00",
  "symbol_id": "USDTBEP20",
  "status": "executed",
  "amount": "4.696700000000000000",
  "service_fee": "0.803300000000000000",
  "net_amount": "5.500000000000000000",
  "blockchain_data": {
    "hash": "0xabc...",
    "from_address": "0x123",
    "to_address": "0x456"
  },
  "external_id": null,
  "callback_url": "https://example.com/cb"
}

Invoice webhook

A separate callback fires when the invoice status changes (executed, expired). The body format and signature verification are covered under Invoice webhook in the Signing section.

Deposit statuses

statusDescription
pendingAwaiting AML or network confirmations
executedCredited to the balance
dirty_lockAddress flagged dirty, deposit locked
cancelledCancelled

Invoice statuses

statusDescription
activeAwaiting payment
executedPaid
expiredExpired
cancelledCancelled

Webhook delivery

If your server responds with an error, the webhook is retried automatically.

If your server already returned 2xx to the first webhook, no retry is sent when the status later changes to executed. With AML or pending confirmations, the first webhook may arrive with the pending status.

Query the current transaction status via GET /user/transaction/ or GET /user/transaction/{encoded_id}/.

Minimum amount

Deposits below min_deposit_amount are ignored. For the current value, see GET /setting/fees/ (Reference).

Withdrawals

Withdrawals

Endpoints

MethodPathDescription
POST/user/balance/withdrawal/Create a withdrawal
GET/user/transaction/?type=withdrawalHistory and status
GET/user/transaction/{encoded_id}/A single transaction

There is no separate GET /withdrawal/{id}. Use the transaction API.

POST /user/balance/withdrawal/

Query

ParameterDescription
totp_codeEmail OTP. Not required when authenticating with an API key

Request

FieldTypeDescription
symbol_id*stringSymbol identifier, e.g. USDTTRC20. For the list of values, see GET /symbol/ (Reference)
to_address*stringRecipient address
amount*decimalAmount to the recipient (net)
external_idstringYour ID
callback_urlstringWebhook URL
extra.memostringMemo/tag (if the network supports it)

Virtual symbols are not accepted.

The fee is charged on top of amount. Your balance is debited by amount + service_fee.

Response

A transaction object as JSON: "type": "withdrawal", the current withdrawal status in status, and the identifier in encoded_id.

Errors

detailReason
Insufficient balanceNot enough funds
Invalid addressInvalid address
Minimum withdrawal amount is ...Below the minimum
TOTP code is requiredtotp_code required without an API key
MEMO doesn't supported on this chain!Memo not supported

Rate limit: 15 requests per 15 seconds.

GET /user/transaction/

ParameterDescription
typewithdrawal
statusWithdrawal status
in_processingtrue — in-progress withdrawals only
external_idYour ID

Withdrawal webhook

Sent once, when the withdrawal moves to the executed status.

Body

A transaction object as JSON with "type": "withdrawal". The fields match the deposit webhook object.

FieldDescription
amountTransaction amount (recipient + fee)
service_feeFee
net_amountAmount to the recipient (amount - service_fee)
statusexecuted
blockchain_data.hashTx hash
to_addressRecipient address
memoMemo, if any
external_idYour ID

The signature is verified with callback_key, using the X-Signature and X-Timestamp headers and the data structure with params and body.

Withdrawal statuses

statusDescription
compliance_approve_requiredAwaiting manual approval
createdQueued
aml_order_pendingAML check
prepare_pendingPreparing the transaction
ready_to_transferReady to send
transfer_lockSending to the network
pendingAwaiting confirmations
swap_lockAwaiting autoswap
executedCompleted
cancelledCancelled by an admin
cancelled_by_riskCancelled by AML
failedFailed

The in_processing=true filter returns every status except executed, cancelled, cancelled_by_risk, and failed.

Limits

ParameterDescription
min_withdrawal_amountMinimum per symbol and tariff. For the value, see GET /setting/fees/
withdrawal_fee_amountFixed fee
withdrawal_fee_percentagePercentage fee
totp_codeRequired without an API key (email OTP, 10 min)

Repeating a request with the same external_id is not idempotent.

Reference

Reference

Helper methods that the operations in the other sections rely on.

Endpoints

MethodPathDescription
GET/symbol/List of symbols
GET/symbol/fiat/List of supported fiat currencies
GET/user/balance/Balance by symbol
GET/setting/fees/Fees and limits
GET/currency/rate/Currency pair rates
GET/currency/rate/hedge/Rates to USDT (source: aster_dex)

GET /symbol/

Use it to get valid symbol_id values when creating an address, invoice, or withdrawal.

Query

ParameterDescription
pagePage number, 1 by default
per_pagePage size, 100 by default
search_querySearch by id, name, short_name
order_typesymbol, short_name, name
order_ascAscending order, true by default

Response

A paginated list. Each item:

FieldDescription
idSymbol identifier for the API (symbol_id)
nameFull name
short_nameShort currency name
blockchainNetwork: id, name, explorer links
is_activeWhether the symbol is available
is_virtualVirtual symbol (don't use for the API)
group_symbol_idBalance group, if the symbol is grouped
balance_symbol_idSymbol the balance is kept in
contract_addressToken contract address, if any
precisionPrecision

For symbol_id requests, pick records with is_virtual: false and is_active: true.

GET /symbol/fiat/

A list of fiat currency codes for the target_currency_fiat field when creating an invoice.

Response

An array of strings, e.g. ["USD", "EUR", ...].

GET /user/balance/

The account's current balance. Handy before creating a withdrawal.

Query

ParameterDescription
search_queryFilter by symbol_id

Response

An array of objects:

FieldDescription
symbol_idSymbol identifier
valueAvailable balance

Rate limit: 30 requests per minute.

GET /setting/fees/

Fees and minimum amounts by symbol.

Query

ParameterDescription
user_idUser ID for personalized settings
tariff_idTariff ID

Without parameters, global values are returned. Pass your user_id to get your actual limits and fees.

Response

An array of objects by symbol:

FieldDescription
symbol_idSymbol identifier
min_deposit_amountMinimum deposit
min_withdrawal_amountMinimum withdrawal
deposit_fee_amountFixed deposit fee
deposit_fee_percentageDeposit fee percentage
withdrawal_fee_amountFixed withdrawal fee
withdrawal_fee_percentageWithdrawal fee percentage

GET /currency/rate/

Currency pair rates.

Query

ParameterDescription
sourceSource: coingecko or aster_dex. Without the parameter — all sources

Response

An array of objects:

FieldDescription
from_symbol_idThe crypto symbol_id, or a fiat code (for fiat→fiat pairs)
to_symbol_nameQuote currency code: fiat (USD, EUR, ...) or USDT
valueRate: how many units of to_symbol_name per 1 unit of from_symbol_id
sourcecoingecko or aster_dex
created_atUpdate time

Example pairs

sourcefrom_symbol_idto_symbol_nameMeaning
coingeckoUSDTBEP20USDCrypto symbol to fiat
coingeckoUSDEURFiat to fiat
aster_dexBTCUSDTCrypto symbol to USDT

GET /currency/rate/hedge/

Only from_symbol_idUSDT rates from the aster_dex source. The response format matches GET /currency/rate/.

AI integration

Integrating with the help of AI

The Cryptoway documentation is built so that you can hand it to an AI assistant in one piece — ChatGPT, Claude, Gemini, Cursor, Copilot or any other. It reads the specification and writes a working integration in PHP, Node.js, Python, Go or Rust in minutes rather than hours.

The complete documentation, the full API specification and the brand guide are bundled into a single file.

:::copy https://docs.cryptoway.com/llms-full.txt | Copy the link | Link copied

Copy the link, hand it to your assistant and describe the task: which language you need and what exactly to integrate. If your assistant cannot browse the web, open the file at that link and paste its contents into the chat instead.

The file is rebuilt together with the documentation, so it cannot drift out of sync with it. The specification is also available on its own as openapi.json.

A ready-made prompt

The complete documentation of the Cryptoway payment API: https://docs.cryptoway.com/llms-full.txt
Read it in full before writing any code.

Task: write an integration in <language or framework> that
1) creates a payment invoice,
2) verifies the signature of an incoming webhook,
3) handles payment statuses.

Requirements:
- follow the HMAC-SHA256 signing scheme from the "Signing" section exactly;
- use only the endpoints and fields present in the documentation, invent nothing;
- read keys from environment variables, never hardcode them;
- add error handling and retries on the webhook receiver.

What to double-check after the assistant

Signing. The most common mistake an AI makes is the field order and encoding used to build the HMAC-SHA256 string. Verify the result against the Signing section.

Keys. The generated code must not contain hardcoded API keys or secrets — only reads from environment variables.

Webhooks. Make sure the incoming notification signature is actually verified and that a redelivery of the same event does not create a duplicate order.

Amounts. Crypto amounts must be handled as strings or decimals, never as floating-point numbers.

Live keys. Test the generated code on a sandbox project before you plug in live keys.

Premium Exchange

How to connect to Premium Exchanger

Connect Cryptoway to an exchange running the Premium Exchanger (v 2.7) script via two modules:

  • Merchant (incoming payments) — receives the client's funds into your accounts and automatically moves the order to the “Paid order” status.
  • Auto-payout — pays the client out from your accounts.

Together they fully automate the exchange. You can connect just one module to automate only the accept side or only the payout side.

Full Premium Exchanger documentation: Merchant and auto-payout modules

What you need

  • An exchanger on Premium Exchanger 2.7.x. Modules are version-locked: a 2.7 script needs 2.7.* modules, otherwise the site won't load.
  • Server access via ISP Manager as the site user (not root).
  • Cryptoway keys with deposit + withdrawal permissions — the Project ID and secret (see Signing).

Step 1. Module files

ModuleArchivePurpose
Merchant (incoming payments)m_cryptoway_271.zipAccept crypto payments
Auto-payoutspay_cryptoway_271.zipAutomatic payouts

The module version must match your Premium Exchanger script version (e.g. 271 for 2.7.\*).

Step 2. Upload to the server

Back up the site root folder first. Work through ISP Manager as the site user (not root).

  1. Upload the cryptoway folder from m_cryptoway_271.zip to /wp-content/plugins/premiumbox/merchants.
  2. Upload the cryptoway folder from pay_cryptoway_271.zip to /wp-content/plugins/premiumbox/paymerchants.
  3. If a file-conflict dialog appears, click “Replace”.

Step 3. Add and configure the merchant

In “Merchants” → “Merchants” click “Add” (some merchants exist by default). Fill the form:

Add-merchant form in Premium Exchanger

  • Title — the merchant name shown in the admin panel.
  • Module — pick Cryptoway from the dropdown.
  • Status — set “active merchant”.

In the module settings, enter the keys from your Cryptoway dashboard:

  • API key — paste the Project ID from your Cryptoway dashboard here.
  • Secret key — your API key's secret.

Step 4. Auto-payouts

The auto-payout module is connected the same way: the “Auto-payouts” section → “Add”, status “active”, the same Cryptoway keys (Project ID + secret). It is bound on the “Merchants and payouts” tab of the direction — for the “You get” currency. Before enabling it, read the “Risk warning” section of the Premium Exchanger docs.

Step 5. Operation modes

The exchanger starts in manual mode. With the modules:

  • Merchant only (accept) — accepting is automated: when funds arrive the order moves to “Paid order”, and you pay out manually and set the status to “Completed order”.
  • Merchant + auto-payout — full automation: “Paid order” → “Awaiting confirmation from the auto-payout module” → “Completed order”.
  • You can enable the “Transfer” button on an order even for an automated direction, so an operator can pay out manually if an auto-payout fails.

Step 6. Verify

Check the connection with the built-in “Merchant diagnostics” (Merchants → Merchants → diagnostics):

Merchant log and diagnostics in Premium Exchanger

  • Make sure the server's task scheduler (cron) is configured — without it order statuses won't change automatically.
  • If the log shows a “your IP … not in whitelist” error, add your server's IP to the Cryptoway API key whitelist (the allowed_ips parameter).

iEXExchanger

How to connect to iEXExchanger

Connect Cryptoway to an exchange running the iEXExchanger script via the built-in Cryptoway merchant. Once connected, iEXExchanger creates the payment address itself, watches for incoming funds and automatically moves the order to the next status after the payment is confirmed.

The module supports:

  • creating payment addresses;
  • automatic detection of incoming funds;
  • webhook notifications;
  • manual and automatic payment checks;
  • working with several blockchain networks.

Important. Before enabling the merchant on a live direction, always run a test payment for a small amount. If the API key, Callback Key or network is set incorrectly, the payment address may not be created and automatic processing won't work.

Full iEXExchanger documentation: Cryptoway merchant.

What you need

Before configuring, prepare the data from your Cryptoway dashboard:

  • Project ID
  • Secret key

In the iEXExchanger module these fields still carry the old names, API Key ID and API Key Secret.

To accept crypto, the API key must have the Deposits permission. The Withdrawal permission is for automatic payouts and is not required for an accept-only merchant (see Signing and Deposits).

Step 1. Register and create an API key in Cryptoway

Create an account or sign in at cryptoway.com. Then:

  1. Open the “API keys” section.
  2. Click “Create API key”.
  3. Enter any name for the key.
  4. Optionally specify your server's public IP address.
  5. Enable the Deposits permission.
  6. Confirm the key creation.
  7. Copy the Key ID and Key Secret.

Important. The Key Secret is shown only once, at creation — you can't view it again. If you didn't save it, create a new key pair. Store the data securely and never share it with third parties.

If you leave the allowed-IP list empty, Cryptoway may automatically save the IP of the first successful API request — subsequent requests will only be accepted from that IP.

Step 2. Add the merchant

In the iEXExchanger admin, open “Merchants and API” → “Merchant list” and click “Add”. Pick Cryptoway from the module list.

Step 3. Configure the merchant

Fill in the merchant fields:

  • API Key ID — paste the Project ID from your Cryptoway dashboard here (format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). The module still uses the old field name. Required.
  • API Key Secret — the secret part of the API key. It signs the requests that create payment addresses, check incoming funds and fetch the list of available currencies and networks. Required, with no leading or trailing spaces.
  • API Base URL — leave the default value https://api.cryptoway.com. Change it only if Cryptoway technical support tells you to; don't put your dashboard address or your exchanger domain here.
  • Callback Key — leave empty.

Currency code. Pick the currency-and-network code used in Cryptoway, e.g. USDTTRC20, USDTBEP20 or BNBBEP20. A bare currency code without a network (e.g. USDT) is not allowed — Cryptoway accepts a code bound to a specific blockchain network. If “Automatic” is selected, the system uses the network code from the currency settings; make sure in advance that it matches the currency identifier in Cryptoway.

Max blockchain registration time — set in minutes, recommended value 30. This is how long the system waits for the transaction to register on the blockchain.

Max time to first confirmation — set in hours, recommended value 2. This is how long the system waits for the first transaction confirmation.

Step 4. Bind the merchant to a currency

After saving the merchant, assign it to the right currency. Open “Main” → “Currencies” → “Currency list”, pick the currency, go to the automation section and select Cryptoway as the merchant.

Make sure the selected network matches the network set in the merchant settings. For example:

  • Currency: USDT
  • Network: TRC20
  • Cryptoway code: USDTTRC20
  • Merchant: Cryptoway

If one currency is used on several networks, create a separate copy of the merchant for each network.

How payment acceptance works

When an order is created, iEXExchanger sends a request to the Cryptoway API. Cryptoway creates a permanent address and returns it to the system, and the client transfers funds to that address. When the payment reaches the executed status, iEXExchanger automatically moves the order to the next status. To link the payment to the order, iEXExchanger passes the order identifier to Cryptoway.

The amount actually received is taken from the amount value — the sum credited to the Cryptoway balance after the service fee. Account for the Cryptoway fee when configuring the exchange direction: the on-chain transfer amount may differ from the amount actually credited to the balance.

What to check before launch

  • the API Key ID and API Key Secret fields are filled in correctly — they hold the Project ID and Secret key from the dashboard;
  • the Deposits permission is enabled for the API key;
  • API Base URL is https://api.cryptoway.com;
  • the currency code and network are set without errors, and no network-less code (e.g. USDT) is used;
  • the exchanger backend is reachable over HTTPS;
  • the server's public IP is allowed in the API key settings;
  • the merchant is bound to the right currency or direction;
  • the Cryptoway minimum amount and fee are accounted for;
  • request logging is enabled during testing.

Verifying the setup

  1. Create a test order.
  2. Make sure a payment address appears.
  3. Check that the address matches the selected network.
  4. Send a small amount.
  5. Wait for the payment to be processed.
  6. Check that the order status changes.
  7. Make sure the payment reaches the executed status.
  8. Check that the transaction hash is saved.
  9. Reconcile the order amount with the amount credited to the Cryptoway balance.
  10. Check the request log: “Event log” → “Merchants and API” → “Merchant request log”.

Recommendations

  • Use a separate Cryptoway API key for each exchanger.
  • Use different API keys for accepting payments and for automatic payouts.
  • Never publish API Key ID and API Key Secret in chats or screenshots.
  • Always run a test payment before enabling the merchant on live directions.
  • Check the current minimum deposit amount and fee for the selected currency.
  • Once verified, you can turn off verbose request logging.

WooCommerce

Cryptoway plugin for WooCommerce

The plugin adds crypto payments to WooCommerce. The customer places an order in the store's usual checkout, pays the invoice on the Cryptoway page and returns to the confirmation page, while the order status updates on its own.

What you need

  • WordPress 6.9 or newer;
  • PHP 8.1 or newer;
  • WooCommerce 9.0 or newer;
  • a Cryptoway account with an active project.

The plugin supports the WooCommerce block checkout and High-Performance Order Storage (HPOS).

Get access

  1. Sign up in the Cryptoway dashboard.
  2. Open Projects and click New project.
  3. Fill in the request: project name, site address and a contact.
  4. Wait for the Active status. A manager reviews the request, usually within one business day. Until then the project shows as In review.
  5. On the project page click API keys.
  6. Copy the Project ID, Callback key and Secret key.

Important. Project keys only work from the address they were first used from. Set up a separate project for each store.

Installation

From the WordPress catalogue
  1. Open Plugins → Add New.
  2. Search for Cryptoway.
  3. Install and activate the plugin.
By uploading the archive
  1. Open Plugins → Add New → Upload Plugin.
  2. Pick the plugin archive and click Install.
  3. Activate the plugin.
Manually

Upload the plugin folder to /wp-content/plugins/ and activate the plugin under Plugins.

Make sure WooCommerce is installed and active.

Payment method settings

Open WooCommerce → Settings → Payments → Cryptoway.

FieldValue
Payment methodTurns on payments through Cryptoway.
Checkout titleThe name of the payment method at checkout.
Text under the titleOne line the customer sees. Can be left empty.
Other languagesTitle and text for the site's other languages.
Project IDThe first value from the Project credentials window.
Callback keyThe second value. Leave it empty and the plugin will fetch it on save.
Secret keyThe third value.
Time to payFrom 15 to 1440 minutes. 60 by default. The rate is fixed for this period.
Minimum orderBelow this amount the payment method is hidden. Zero means no limit.
Maximum orderAbove this amount the payment method is hidden. Zero means no limit.
Detailed logTurn it on while you set things up.

Save the changes.

Important. Test mode in WooCommerce is shared by all payment methods. While it is on, orders are not sent to Cryptoway.

Project settings

The rest is configured in the Cryptoway dashboard: open the project and go to the Settings tab.

SectionWhat it sets
Auto-conversion on receiptConverts incoming assets into the currency you choose.
Payment page appearanceColour, logo and theme of the page the customer pays on.
Payment page layoutInvoice view: one column or two.
Project informationThe recipient's details. They are printed on the invoice.
Fee and markupWho pays the Cryptoway fee and whether a markup is added to the invoice.
Allowed IPsServer addresses allowed to call the project's API.

Important. New fee and markup rules apply to invoices created after the change. Invoices already issued are settled by the previous rules.

How a payment goes through

  1. The customer picks Cryptoway at checkout.
  2. The plugin creates an invoice for the order amount and sends the customer to the Cryptoway payment page.
  3. The customer picks a coin and a network and sends the amount.
  4. The plugin matches the amount and currency against the order and marks the order paid.
  5. The customer returns to the order confirmation page.

It usually takes seconds from payment to the status change. If the notification does not arrive, the plugin re-checks the invoice itself within ten minutes.

Order statuses

What happenedWhat the plugin does
Paid in fullMoves the order to «Processing» and records the amount and coin in the history.
Less than the order amount arrivedPuts the order on hold and flags it for review. The order is not shipped.
More than the order amount arrivedThe order is paid, the difference is noted in the history.
Time to pay ran outCancels the order or leaves it payable, depending on your setting.
Payment cancelledCancels the order.
Payment held by a security checkPuts the order on hold until Cryptoway decides.
Money arrived for an already cancelled orderPuts the order on hold and warns in the history: the goods may have returned to stock.

An order counts as paid only after the amount and currency are matched. An underpaid order is not shipped automatically.

Checking after setup

  1. Create a small test order.
  2. Pick Cryptoway at checkout.
  3. Make sure the Cryptoway payment page opens.
  4. Pay the invoice.
  5. Check that the order moved to «Processing» and that the payment number, coin and transaction hash appeared in its card.

If the status has not changed, open the order card and run the payment status check.

Troubleshooting

ProblemWhat to check
Cryptoway does not appear at checkoutThe plugin is active, the payment method is enabled, Project ID and Secret key are filled in, the order amount falls within the limits you set.
The payment page does not openThe project has the Active status, the keys were copied from the Project credentials window without stray spaces.
The order did not update after paymentThe Callback key is filled in. Open the order card and run the payment status check.
Cryptoway denies accessKeys are bound to the server address they were first used from. Set up a separate project for the store or clear the list under «Allowed IPs».
You need request detailsTurn on the detailed log and repeat the order: WooCommerce → Status → Logs.

Rates and the coin list are on the Cryptoway site. Support: @cryptoway_support_bot.

Easy Digital Downloads

Cryptoway plugin for Easy Digital Downloads

The plugin adds crypto payments to Easy Digital Downloads. The customer places an order in the store's usual checkout, pays the invoice on the Cryptoway page and returns to the confirmation page, while the order status updates on its own.

What you need

  • WordPress 6.9 or newer;
  • PHP 8.1 or newer;
  • Easy Digital Downloads 3.2 or newer;
  • a Cryptoway account with an active project.

Get access

  1. Sign up in the Cryptoway dashboard.
  2. Open Projects and click New project.
  3. Fill in the request: project name, site address and a contact.
  4. Wait for the Active status. A manager reviews the request, usually within one business day. Until then the project shows as In review.
  5. On the project page click API keys.
  6. Copy the Project ID, Callback key and Secret key.

Important. Project keys only work from the address they were first used from. Set up a separate project for each store.

Installation

From the WordPress catalogue
  1. Open Plugins → Add New.
  2. Search for Cryptoway.
  3. Install and activate the plugin.
By uploading the archive
  1. Open Plugins → Add New → Upload Plugin.
  2. Pick the plugin archive and click Install.
  3. Activate the plugin.
Manually

Upload the plugin folder to /wp-content/plugins/ and activate the plugin under Plugins.

Make sure Easy Digital Downloads is installed and active.

Payment method settings

  1. Open Downloads → Settings → Payments.
  2. Enable Cryptoway in the list of payment methods.
  3. Go to the Cryptoway section and fill in the fields.
FieldValue
Checkout titleThe name of the payment method at checkout.
Text under the titleOne line the customer sees. Can be left empty.
Other languagesTitle and text for the site's other languages.
Project IDThe first value from the Project credentials window.
Callback keyThe second value. Leave it empty and the plugin will fetch it on save.
Secret keyThe third value.
Time to payFrom 15 to 1440 minutes. 60 by default. The rate is fixed for this period.
Minimum orderBelow this amount the payment method is hidden. Zero means no limit.
Maximum orderAbove this amount the payment method is hidden. Zero means no limit.
Detailed logTurn it on while you set things up.

Save the changes.

Important. Test mode in Easy Digital Downloads is shared by all payment methods: Downloads → Settings → Payments → Test mode. While it is on, orders are not sent to Cryptoway.

Project settings

The rest is configured in the Cryptoway dashboard: open the project and go to the Settings tab.

SectionWhat it sets
Auto-conversion on receiptConverts incoming assets into the currency you choose.
Payment page appearanceColour, logo and theme of the page the customer pays on.
Payment page layoutInvoice view: one column or two.
Project informationThe recipient's details. They are printed on the invoice.
Fee and markupWho pays the Cryptoway fee and whether a markup is added to the invoice.
Allowed IPsServer addresses allowed to call the project's API.

Important. New fee and markup rules apply to invoices created after the change. Invoices already issued are settled by the previous rules.

How a payment goes through

  1. The customer picks Cryptoway at checkout.
  2. The plugin creates an invoice for the order amount and sends the customer to the Cryptoway payment page.
  3. The customer picks a coin and a network and sends the amount.
  4. The plugin matches the amount and currency against the order and marks the order paid.
  5. The customer returns to the order confirmation page.

It usually takes seconds from payment to the status change. If the notification does not arrive, the plugin re-checks the invoice itself within ten minutes.

Order statuses

What happenedWhat the plugin does
Paid in fullMoves the order to «Complete» and records the amount and coin in the history.
Less than the order amount arrivedPuts the order on hold and flags it for review. Files are not released.
More than the order amount arrivedThe order is paid, the difference is noted in the history.
Time to pay ran outCloses the order as unpaid.
Payment cancelledCloses the order as unpaid.
Payment held by a security checkPuts the order on hold until Cryptoway decides.
Money arrived for an already closed orderPuts the order on hold and warns in the history.

An order counts as paid only after the amount and currency are matched. Files are not released for an underpaid order.

Checking after setup

  1. Create a small test order.
  2. Pick Cryptoway at checkout.
  3. Make sure the Cryptoway payment page opens.
  4. Pay the invoice.
  5. Check that the order moved to «Complete» and that the payment number, coin and transaction hash appeared in its card.

If the status has not changed, open the order card and run the payment status check.

Troubleshooting

ProblemWhat to check
Cryptoway does not appear at checkoutThe plugin is active, the gateway is enabled in the list of payment methods, Project ID and Secret key are filled in, the order amount falls within the limits you set.
The payment page does not openThe project has the Active status, the keys were copied from the Project credentials window without stray spaces.
The order did not update after paymentThe Callback key is filled in. Open the order card and run the payment status check.
Cryptoway denies accessKeys are bound to the server address they were first used from. Set up a separate project for the store or clear the list under «Allowed IPs».
You need request detailsTurn on the detailed log and repeat the order.

Rates and the coin list are on the Cryptoway site. Support: @cryptoway_support_bot.