/v1/public/*) — это интеграционный слой между вашей CMS и кошельком: через него вы
создаёте депозиты, отправляете выплаты, получаете подписанные webhooks и читаете справочники
валют, сетей и балансов.
У каждого клиента — свой инстанс (свой сервер, свои ключи, своя БД, свой base URL).
Поэтому все примеры в документации используют плейсхолдер
https://wallet.your-exchange.com —
замените его на адрес вашего инстанса. См. Окружения.Что можно делать через API
Принимать депозиты
Создать адрес на оплату, отслеживать поступление, получать webhooks при финализации.
Отправлять выплаты
Создать выплату на адрес получателя, оценить комиссию, отслеживать подтверждение.
Webhooks
Подписанные HMAC-уведомления о смене статусов депозитов и выплат.
Валюты, сети, балансы
Читать каталог активов, список сетей и доступные средства hot-кошельков.
Ключевые принципы
- Подпись каждого запроса. Каждый вызов
/v1/public/*подписываетсяHMAC-SHA256. Секрет (api_secret) никогда не передаётся по сети — сервер проверяет подпись у себя. См. Аутентификация. - Деньги — строками. Все суммы передаются как
string(например"100.50"), чтобы избежать потерь точностиfloat. В базе —NUMERIC(36, 18). - Идемпотентность. Повтор запроса с тем же
order_id(или с тем жеX-Idempotency-Key) не создаёт дубликат. См. Идемпотентность. - Единый конверт ответа. Успех —
{ "ok": true, "data": ... }, ошибка —{ "ok": false, "error": { "code": "...", "message": "..." } }. См. Ошибки. - IP-whitelist. Запросы принимаются только с IP-адресов из белого списка вашего сайта (если он задан). См. Окружения.
Конверт ответа
Любой ответ API — это конверт. Всегда сначала проверяйте полеok, затем читайте data
или error.
С чего начать
Быстрый старт: первый депозит за 5 минут
Получите API-ключ, подпишите запрос, создайте депозит и поймайте webhook.
Аутентификация
Как подписать запрос HMAC-SHA256.
Окружения
Base URL, IP-whitelist, health-проверка.
Валюты и сети
Справочники
assets, networks, balances.Коды ошибок
Полный список кодов и как на них реагировать.
Частые вопросы
Где взять base URL?
Где взять base URL?
Base URL индивидуален для вашего инстанса и выдаётся при подключении. Все эндпоинты
живут под
/v1/public/*. Подробнее — Окружения.Передаётся ли api_secret по сети?
Передаётся ли api_secret по сети?
Нет. Секрет используется только локально для вычисления
X-Signature. По сети уходит
лишь подпись. См. Аутентификация.Почему суммы — строки, а не числа?
Почему суммы — строки, а не числа?
Чтобы не терять точность на
float. Передавайте и читайте суммы как строки
("100.50"), а для арифметики используйте decimal-библиотеку на своей стороне.Как избежать дубликатов при ретраях?
Как избежать дубликатов при ретраях?
Используйте идемпотентность: задайте
orderId в теле запроса и/или передайте
X-Idempotency-Key. См. Идемпотентность.