Краткое описание методов API
JWT
Generate JWT
POST /jwt/generate
Параметры: API ключ, секретный ключ, время жизни
Описание: Создание JWT для аутентификации
Документация: https://rapira.apidog.io/generate-jwt-20953412e0
Инструкция для настройки JWT https://rapira.apidog.io/%D0%B8%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8E-jwt-1474374m0
CRYPTO MERCHANT – Адреса
- POST /open/deposit_address
Обязательные параметры: currency
Необязательные параметры: —
Описание: Генерация адреса для депозита указанной валюты
Будет возвращен новый адрес для указанной сети.
Если у пользователя еще нет адреса, то он будет создан (может потребоваться новый запрос, если создание адреса займет больше времени)
Ссылка на документацию: https://rapira.apidog.io/get-address-by-currency-20953413e0 - GET /open/deposit_address/details
Обязательные параметры: id (ID адреса)
Необязательные параметры: —
Описание: Получение деталей созданного адреса
Ссылка на документацию: https://rapira.apidog.io/get-address-details-by-id-20953415e0 - GET /open/deposit_address/list
Обязательные параметры: currency
Необязательные параметры: pageNo, pageSize
Описание: Список адресов по валюте
Ссылка на документацию: https://rapira.apidog.io/get-address-list-by-currency-20953416e0 - POST /open/deposit_address/use/start
Обязательные параметры: address
Необязательные параметры: —
Описание: Активировать использование адреса (необходимо для переиспользования адресов) (Подробная документация по переиспользованию: https://buildin.ai/share/addabaa3-d571-4f54-949b-3c37ab99428f?code=UW3A5N
[Buildin.AI]Инструкция для интеграции мерчанта Rapira )
Ссылка на документацию: https://rapira.apidog.io/start-use-address-21806076e0 - POST /open/deposit_address/use/stop
Обязательные параметры: address
Необязательные параметры: —
Описание: Деактивировать использование адреса (необходимо для переиспользования адресов) (Подробная документация по переиспользованию: https://buildin.ai/share/addabaa3-d571-4f54-949b-3c37ab99428f?code=UW3A5N
[Buildin.AI]Инструкция для интеграции мерчанта Rapira)
Ссылка на документацию: https://rapira.apidog.io/stop-use-address-20953417e0
CRYPTO MERCHANT – Депозиты
- POST /open/deposit/records
Обязательные параметры: pageNo, pageSize
Необязательные параметры: unit (валюта, например USDT), address (для фильтрации по адресу)
Описание: Возвращает список депозитов с пагинацией и фильтрацией по валюте или адресу
Ссылка на документацию: https://rapira.apidog.io/get-deposits-20953418e0
MARKET - курсы и доступные токены и торговые пары
- GET /open/my-spot-fee
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает комиссии пользователя для спотовой торговли
Ссылка на документацию: https://rapira.apidog.io/get-spot-fees-20953411e0GET /open/market/pairs - GET /open/market/pairs
Обязательные параметры: —
Необязательные параметры: —
Лимиты запросов: 5 запросов в секунду, не более 100 запросов в минуту
Описание: Возвращает список доступных торговых пар
Ссылка на документацию: https://rapira.apidog.io/pairs-20953419e0 GET /open/token
Обязательные параметры: —
Необязательные параметры: —
Лимиты запросов: 5 запросов в секунду, не более 100 запросов в минуту
Описание: Возвращает список доступных токенов и их характеристики.- Rechargeable (boolean) — если true, депозит доступен; если false, пополнение недоступно
- Withdrawable (boolean) — если true, вывод средств доступен; если false, вывод недоступен
Ссылка на документацию: https://rapira.apidog.io/token-20953420e0
- GET /open/rates
Обязательные параметры: —
Необязательные параметры: —
Лимиты запросов: 5 запросов в секунду, не более 100 запросов в минуту
Описание: Возвращает спотовые курсы всех торговых пар в формате JSON
Ссылка на документацию: https://rapira.apidog.io/get-rates-json-20953421e0 - GET /open/rates/xml
Обязательные параметры: —
Необязательные параметры: —
Лимиты запросов: 5 запросов в секунду, не более 100 запросов в минуту
Описание: Возвращает спотовые курсы всех торговых пар в формате XML
Ссылка на документацию: https://rapira.apidog.io/get-rates-xml-20953422e0 - POST /market/exchange-plate-mini
Обязательные параметры: symbol — торговая пара (например "BTC/USDT")
Необязательные параметры: —
Лимиты запросов: 5 запросов в секунду, не более 100 запросов в минуту
Описание: Возвращает упрощённый стакан ордеров (bid/ask) для указанной валютной пары. Если в ответе приходит {}, значит указана неверная пара.
Ссылка на документацию: https://rapira.apidog.io/get-market-depth-20953423e0
BALANCE
GET /open/wallet/balance/frozen
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает замороженные балансы, сгруппированные по типам счетов (например: WITHDRAW, P2P, RECHARGE, EXCHANGE, ADMIN). Все значения представлены в USDT.
Ссылка на документацию: https://rapira.apidog.io/get-frozen-balances-27591088e0
GET /open/wallet/balance/operations/categories-coins
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает список доступных монет и типов операций, используемых для фильтрации в запросе истории операций баланса.
Ссылка на документацию: https://rapira.apidog.io/get-balance-operations-coins-and-types-27591110e0
POST /open/wallet/balance/operations
Обязательные параметры: coins, types, fromDate, toDate, pageNumber, sizeByPage
Необязательные параметры: —
Описание: Возвращает историю операций баланса с пагинацией и фильтрацией по монетам, типам операций и диапазону дат.
Ссылка на документацию: https://rapira.apidog.io/get-balance-operations-27592318e0
GET /open/wallet/balance/frozen/detailed
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает детализированную информацию о замороженных балансах по типам счетов и валютам.
Ссылка на документацию: https://rapira.apidog.io/get-frozen-balances-detailed-28260556e0
GET /open/wallet/balance
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает балансы по всем активам пользователя.
Ссылка на документацию: https://rapira.apidog.io/get-balances-20953424e0
SERVER TIME
GET /open/system/time
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает текущее системное время сервера.
Ссылка на документацию: https://rapira.apidog.io/get-server-time-20953425e0
ORDER
GET /open/order/history
Обязательные параметры: —
Необязательные параметры: symbol (торговая пара), coin (валюта), type (тип ордера), status (статус ордера), startTime, endTime, direction (направление ордера), pageNo, pageSize
Описание: Возвращает историю биржевых ордеров с пагинацией. Поддерживается фильтрация по торговой паре, валюте, типу и статусу ордера, направлению сделки, а также диапазону времени.
Ссылка на документацию: https://rapira.apidog.io/order-history-20953426e0
GET /open/order/details
Обязательные параметры: orderId
Необязательные параметры: —
Описание: Возвращает детальную информацию по указанному ордеру.
Ссылка на документацию: https://rapira.apidog.io/order-details-20953427e0
POST /open/order/add
Обязательные параметры: symbol, price, amount, direction, type
Необязательные параметры: —
Описание: Создает ордер на бирже для обмена валюты. Поддерживаются рыночные и лимитные ордера. Для лимитного ордера необходимо указать цену.
Ссылка на документацию: https://rapira.apidog.io/add-exchange-order-20953428e0
POST /open/order/{orderId}/cancel
Обязательные параметры: orderId
Необязательные параметры: —
Описание: Отменяет указанный ордер на бирже по его идентификатору.
Ссылка на документацию: https://rapira.apidog.io/cancel-order-20953429e0
CRYPTO PAYOUT
POST /open/withdraw/create
Обязательные параметры: address, amount, nonce, code или coin + chain
Необязательные параметры: memo, conversionDetails, conversionEnabled, convertFromCurrency, enoughCoinPayment
Описание: Создает заявку на вывод средств на указанный адрес. Валюту можно передать либо через code, либо через связку coin и chain. Поддерживается настройка автоконвертации перед выводом.
Ссылка на документацию: https://rapira.apidog.io/withdraw-create-20953430e0
GET /open/withdraw/crypto/history/{withdraw_id}
Обязательные параметры: withdraw_id
Необязательные параметры: —
Описание: Возвращает детальную информацию по заявке на вывод криптовалюты. Включает текущий статус обработки (создана, в работе, выполнена, отклонена и др.).
Ссылка на документацию: https://rapira.apidog.io/withdraw-crypto-history-record-20953431e0
GET /open/withdraw/crypto/history
Обязательные параметры: pageNo, pageSize
Необязательные параметры: —
Описание: Возвращает историю выводов криптовалюты с пагинацией. Содержит информацию о статусах обработки заявок.
Ссылка на документацию: https://rapira.apidog.io/withdraw-crypto-history-20953432e0
FIAT PAYOUT
GET /open/withdraw/fiat/history
Обязательные параметры: pageNo, pageSize
Необязательные параметры: —
Описание: Возвращает историю выводов фиатных средств с пагинацией.
Ссылка на документацию: https://rapira.apidog.io/withdraw-fiat-history-20953433e0
GET /open/withdraw/fiat/history/{withdraw_id}
Обязательные параметры: withdraw_id
Необязательные параметры: —
Описание: Возвращает детальную информацию по заявке на вывод фиатных средств.
Ссылка на документацию: https://rapira.apidog.io/withdraw-fiat-history-record-20953434e0
GET /open/fiat-transactions
Обязательные параметры: —
Необязательные параметры: pageNo, pageSize, transactionType (тип транзакции: WITHDRAW или RECHARGE)
Описание: Возвращает список фиатных транзакций с пагинацией. Поддерживается фильтрация по типу транзакции.
Ссылка на документацию: https://rapira.apidog.io/fiat-transactions-20953452e0
GET /open/fiat-transactions/{transactionId}
Обязательные параметры: transactionId
Необязательные параметры: —
Описание: Возвращает детальную информацию по фиатной транзакции, включая сумму, статус, комиссии и временные метки.
Ссылка на документацию: https://rapira.apidog.io/fiat-withdraw-for-record-20953453e0
AML
POST /open/aml/balance
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает количество оставшихся оплаченных AML-проверок.
Ссылка на документацию: https://rapira.apidog.io/aml-balance-20953435e0
POST /open/aml/recheck
Обязательные параметры: uuid
Необязательные параметры: —
Описание: Запускает повторную AML-проверку для указанного адреса или транзакции по идентификатору проверки.
Ссылка на документацию: https://rapira.apidog.io/recheck-20953436e0
POST /open/aml/check-address
Обязательные параметры: chain, address
Необязательные параметры: —
Описание: Выполняет AML-проверку указанного адреса в выбранной сети.
Ссылка на документацию: https://rapira.apidog.io/check-address-20953437e0
POST /open/aml/check-transaction
Обязательные параметры: token, hash, address, direction
Необязательные параметры: —
Описание: Выполняет AML-проверку транзакции по указанным параметрам, включая валюту, хэш, адрес и направление операции.
Ссылка на документацию: https://rapira.apidog.io/check-transaction-20953438e0
rCode
POST /open/withdrawcode/apply
Обязательные параметры: unit, amount
Необязательные параметры: —
Описание: Создает код для передачи средств другому пользователю биржи. Указанная сумма будет заморожена и списана после активации кода или возвращена на баланс при активации владельцем.
Ссылка на документацию: https://rapira.apidog.io/create-rcode-20953447e0
POST /open/withdrawcode/withdraw/history
Обязательные параметры: pageNo, pageSize
Необязательные параметры: coin, startAmount, endAmount, status, addrOrTxIdPart, startCreationTime, endCreationTime
Описание: Возвращает историю созданных пользователем кодов (rcode) с пагинацией и возможностью фильтрации по валюте, сумме, статусу, части кода и диапазону дат создания.
Ссылка на документацию: https://rapira.apidog.io/rcode-withdraw-history-20953448e0
POST /open/withdrawcode/deposit/history
Обязательные параметры: pageNo, pageSize
Необязательные параметры: coin, startAmount, endAmount, status, addrOrTxIdPart, startCreationTime, endCreationTime
Описание: Возвращает историю зачисленных на баланс кодов (rcode) с пагинацией и возможностью фильтрации по валюте, сумме, статусу, части кода и диапазону дат создания.
Ссылка на документацию: https://rapira.apidog.io/rcode-deposit-history-20953449e0
GET /open/withdrawcode/info/{withdrawCode}
Обязательные параметры: withdrawCode
Необязательные параметры: —
Описание: Возвращает информацию по указанному коду (rcode), включая его текущий статус и детали использования.
Ссылка на документацию: https://rapira.apidog.io/rcode-details-20953450e0
POST /open/withdrawcode/recharge/{withdrawCode}
Обязательные параметры: withdrawCode
Необязательные параметры: —
Описание: Активирует код (rcode) для пополнения баланса или возврата средств, если код был создан текущим пользователем.
Ссылка на документацию: https://rapira.apidog.io/use-rcode-20953451e0
OTC
GET /open /otc/payment-type/fetch
Обязательные параметры: externalCoinUnit
Необязательные параметры: —
Описание: Возвращает иерархический список доступных методов оплаты для выбранной фиатной валюты, сгруппированных по категориям. Ответ содержит уникальные идентификаторы (ID) и названия платежных систем, которые необходимы для корректного создания или редактирования объявлений
Ссылка на документацию: https://rapira.apidog.io/get-payment-types-25179713e0
POST /open /otc/ad/my/page-query
Обязательные параметры: Authorization, merchantSide, pageNo, pageSize
Необязательные параметры: status, paymentTypeIds
Описание: Возвращает список всех торговых объявлений текущего пользователя. Поддерживает пагинацию и фильтрацию по типу операции (покупка/продажа), статусу (активно/скрыто
Ссылка на документацию: https://rapira.apidog.io/get-my-ads-25179714e0
POST /open/otc/ad/create
Обязательные параметры: price, merchantSide, internalCoinUnit / externalCoinUnit, minLimit / maxLimit, quantity, timeLimit, paymentTypeIds
Необязательные параметры: merchantFee, autoReplyMessage, remark, isPrivate, minP2PLevel, excludedTags, minLast30DayCompleted..., isPhoneVerified, isEmailVerified, isTgVerified
Описание: Создание торгового объявления в скрытом статусе. Позволяет задать параметры предложения перед его выводом в стакан
Ссылка на документацию: https://rapira.apidog.io/create-ad-25179715e0
POST /open/otc/ad/update
Обязательные параметры: adId, price, merchantSide, internalCoinUnit / externalCoinUnit, minLimit / maxLimit, quantity, timeLimit, paymentTypeIds
Необязательные параметры: merchantFee, autoReplyMessage, remark, isPrivate, minP2PLevel, excludedTags, minLast30DayCompleted..., isPhoneVerified, isEmailVerified, isTgVerified
Описание: Обновляет данные в ранее созданном объявлении. Набор передаваемых параметров соответствует эндпоинту создания предложения.
Ссылка на документацию: https://rapira.apidog.io/update-ad-25179716e0
POST /open/otc/ad/publish
Обязательные параметры:
Необязательные параметры: —
Описание: Публикует ранее созданное объявление в общем стакане. Переводит статус предложения из PUT_OFF_SHELVES (снято) в PUT_ON_SHELVES (активно).
Ссылка на документацию: https://rapira.apidog.io/publish-ad-25179717e0
POST /open/otc/ad/unpublish
Обязательные параметры: adId, Authorization
Необязательные параметры: —
Описание: Снимает активное объявление с публикации в общем стакане. Переводит статус предложения из PUT_ON_SHELVES (активно) в PUT_OFF_SHELVES (снято).
Ссылка на документацию: https://rapira.apidog.io/unpublish-ad-25179718e0
POST /open/otc/ad/page-query
Обязательные параметры: merchantSide, internalCoinUnit, externalCoinUnit, pageNo, pageSize, Authorization
Необязательные параметры: amount, showOnlyRecommended
Описание: Возвращает список активных объявлений (стакан) из P2P-раздела.
Ссылка на документацию: https://rapira.apidog.io/fetch-ads-21439959e0
POST /open/otc/order/detail
Обязательные параметры: Authorization
Необязательные параметры: orderId
Описание: Возвращает детальную информацию по конкретному OTC-ордеру по его уникальному номеру (orderSn).
Ссылка на документацию: https://rapira.apidog.io/get-order-detail-20953410e0
POST /open/otc/order/create
Обязательные параметры: offerId, customerSide, internalCoinUnit / externalCoinUnit, price, externalAmount / internalAmount, paymentId, Authorization
Необязательные параметры: attachedBankDetails
Описание: Создает новую сделку
Ссылка на документацию: https://rapira.apidog.io/create-order-20951456e0
POST /open/otc/order/accept
Обязательные параметры: orderSn, bankDetails, Authorization
Необязательные параметры: —
Описание: Принимает созданную сделку в работу. Изменяет статус ордера с CREATED (создано) на UNPAID (ожидает оплаты).
Ссылка на документацию: https://rapira.apidog.io/accept-order-25179719e0
POST /open/otc/order/decline
Обязательные параметры: orderSn, Authorization
Необязательные параметры: —
Описание: Переводит ордер в статус отмененного.
Ссылка на документацию: https://rapira.apidog.io/decline-order-25228994e0
POST /open/otc/order/cancel
Обязательные параметры: orderSn, Authorization
Необязательные параметры: —
Описание: Прекращение выполнения сделки с переводом ордера в статус отмененного.
Ссылка на документацию: https://rapira.apidog.io/cancel-order-20951457e0
POST /open/otc/order/message-history/page-query
Обязательные параметры: orderSn, pageNo, pageSize, Authorization
Необязательные параметры: —
Описание: Возвращает сообщения из чата конкретной сделки с поддержкой пагинации. Сообщения в ответе упорядочены хронологически: от старых к новым. Структура ответа идентична эндпоинту /open/otc/offers.
Ссылка на документацию: https://rapira.apidog.io/chat-history-page-query-20951459e0
POST /open/otc/order/pay
Обязательные параметры: orderSn, Authorization
Необязательные параметры: —
Описание: Фиксация отправки оплаты со стороны покупателя.
Ссылка на документацию: https://rapira.apidog.io/pay-order-20951460e0
POST /open/otc/order/release
Обязательные параметры: orderSn, googleCode, Authorization
Необязательные параметры: —
Описание: Подтверждение оплаты продавцом. Фиксирует поступление денег и завершает операцию по ордеру.
Ссылка на документацию: https://rapira.apidog.io/release-order-20951461e0
POST /open/otc/order/appeal/cancel
Обязательные параметры: orderSn, Authorization
Необязательные параметры: —
Описание: Отменяет открытый спор (арбитраж) по сделке. После вызова метода текущий ордер автоматически переходит в статус отмененного.
Ссылка на документацию: https://rapira.apidog.io/cancel-appeal-20951462e0
POST /open/otc/order/history
Обязательные параметры: pageNo, pageSize, Authorization
Необязательные параметры: startCreateTime, endCreateTime, status, orderSn, side
Описание: Получение списка завершенных и активных сделок с возможностью фильтрации по параметрам ордера.
Ссылка на документацию: https://rapira.apidog.io/get-order-history-20951463e0
POST /open/otc/order/appeal/create
Обязательные параметры: orderSn, remark, Authorization
Необязательные параметры: —
Описание: Инициирует открытие арбитражного спора по сделке. Переводит ордер в статус рассмотрения администрацией для разрешения конфликтной ситуации
Ссылка на документацию: https://rapira.apidog.io/create-appeal-20951464e0
POST /open/otc/order/send-message
Обязательные параметры: orderSn, message, Authorization
Необязательные параметры: —
Описание: Отправляет текстовое сообщение в чат активной сделки. Используется для коммуникации между покупателем и продавцом внутри ордера
Ссылка на документацию: https://rapira.apidog.io/send-message-20951465e0
CRYPTO-PROCESSING
POST /open/crypto-processing/invoices/page
Обязательные параметры: pageNo, pageSize, Authorization
Необязательные параметры: statuses
Описание: Возвращает список инвойсов с поддержкой пагинации и фильтрации. Позволяет фильтровать результаты по проектам, сумме, валюте, статусу, транзакциям и времени создания.
Ссылка на документацию: https://rapira.apidog.io/get-invoices-paginated-31108741e0
POST /open/crypto-processing/reject/address
Обязательные параметры: depositId, address, Authorization
Необязательные параметры: —
Описание: Устанавливает адрес для возврата средств в случае обнаружения высокорискового («грязного») депозита. На указанный адрес будет произведен возврат активов, не прошедших проверку AML
Ссылка на документацию: https://rapira.apidog.io/set-deposit-return-address-31109404e0
POST /open/crypto-processing/token-settings/available
Обязательные параметры: —
Необязательные параметры: —
Описание: Возвращает справочник доступных для проекта платежных токенов. Содержит данные о сетях, комиссиях и технических параметрах, необходимых для настройки приема оплат
Ссылка на документацию: https://rapira.apidog.io/get-available-token-settings-31109977e0
POST /open/crypto-processing/token-settings
Обязательные параметры: tokenId, projectUuid, autoConvertMode, discountPercent, enable, projectPayFee
Необязательные параметры: —
Описание: Обновляет параметры платежного токена для конкретного проекта. Позволяет изменить статус доступности, автоконвертацию, скидки и условия оплаты комиссий. Поля tokenId и projectUuid обязательны, остальные обновляются при передаче
Ссылка на документацию: https://rapira.apidog.io/get-project-token-settings-31110562e0
POST /open/crypto-processing/token-settings/batch
Обязательные параметры: tokenId, projectUuid, autoConvertMode, discountPercent, enable, adminDisable, projectPayFee, Authorization
Необязательные параметры: —
Описание: Групповое редактирование настроек токенов в проекте. Для каждого элемента массива обязательны поля tokenId и projectUuid, остальные параметры обновляются только при их передаче
Ссылка на документацию: https://rapira.apidog.io/batch-update-project-token-settings-31111286e0
GET /open/crypto-processing/projects
Обязательные параметры: Authorization
Необязательные параметры: —
Описание: Получение перечня доступных пользователю проектов. Ответ содержит базовые данные по каждому объекту, включая ID, наименование и состояние проекта
Ссылка на документацию: https://rapira.apidog.io/get-projects-31111419e0
POST /open/crypto-processing/projects/edit
Обязательные параметры: uuid, title, link, webhook, enable, Authorization (в заголовке)
Необязательные параметры: —
Описание: Обновляет параметры проекта: название, ссылку, URL вебхука и статус активности. При изменении адреса вебхука автоматически генерируется новый secretKey, который возвращается только в ответе на этот запрос
Ссылка на документацию: https://rapira.apidog.io/edit-project-31178054e0