Документация API
Мы готовим подробную документацию по YELLOWALEX API для мерчантов и разработчиков. Полная версия будет доступна при запуске Merchant API.
Обзор API
YELLOWALEX API позволяет мерчантам и партнёрам программно управлять платежами, создавать счета, отслеживать транзакции и получать уведомления о событиях в реальном времени.
- Базовый URL
-
https://api.yellowalex.tech/v1/ - Формат
- JSON Content-Type: application/json
- Протокол
- HTTPS (TLS 1.2+), REST
Что войдёт в документацию
Справочник по каждому эндпоинту, подпись запросов, события и готовые библиотеки.
-
REST API v1 с полным OpenAPI 3.0 описанием
Примеры запросов и ответов для каждого эндпоинта: Payments (создание, статус, отмена), Invoices (счета), Wallets (балансы), Withdrawals (выводы), Rates (курсы), Reports (отчёты).
-
Аутентификация
Подпись каждого запроса HMAC-SHA256. API-ключи генерируются в личном кабинете мерчанта, доступ можно ограничить списком IP-адресов.
-
Вебхуки
События
payment.completed,payment.failed,withdrawal.processed,invoice.expired. Повторная доставка: до 6 попыток с экспоненциальной паузой. -
Готовые SDK для PHP, Python, JavaScript и Go
PHP (пакет для Laravel), Python, JavaScript/TypeScript (Node.js), Go. Установка через Composer, pip, npm, go get.
-
Коды ошибок
Стандартные HTTP-коды (400, 401, 403, 404, 422, 429, 500) и бизнес-коды:
INSUFFICIENT_BALANCE,KYC_REQUIRED,RATE_EXPIRED,LIMIT_EXCEEDED. -
Интерактивная песочница для тестирования
Что будет в песочнице -
Руководства по интеграции и best practices
Changelog и версионирование API.
Ранний доступ
Хотите интегрировать YELLOWALEX API до публичного запуска? Свяжитесь с нами для получения доступа к закрытой бете.
- Почта для разработчиков api@yellowalex.tech
- Telegram @yellowalex_support