API Documentation
Русский
Русский
  • Авторизация
  • Подпись запросов
  • Список кодов ошибок
  • Webhooks
  • IFrame ордер
  • Виджет приема оплаты
  • Telegram MiniApp
  • API Reference
    • Базовый функционал
      • Проверка корректности подписи x-api-signature
      • Получение монет доступных для приема/отправки транзакций
      • Запрос текущей цены
      • Поиск операции по TX-хешу
      • Проверка корректности адреса
      • Получение истории транзакций
    • Авансовый счет
      • Получение аккаунтов текущего пользователя
      • Получение аккаунта по его ID
      • Получение адреса для пополнения баланса аккаунта
    • Блокчейн-адреса
      • Поиск по ID
      • Отслеживание транзакций
      • Поиск по адресу
      • Мета-данные
      • Транзакции адреса
      • Последняя транзакция адреса
      • Получение списка PayIn адресов
      • Получение списка бизнес адресов
      • Получение рекуррентных адресов
      • Получение списка PayOut адресов
      • Создание нового адрес бизнес кошелька
      • Создание нового адрес PayOut кошелька
    • Персональные адреса
      • Создание пользователя
      • Получение адреса
      • Получение списка адресов
      • Получение пользователя
      • Добавление доверенного адреса
      • Получение списка доверенных адресов
      • Удаление доверенного адреса
    • Ордера
      • Создание ордера
      • Получение информации об ордере
      • Получение списка ордеров
    • Выводы
      • Получение комиссии для проведения вывода
      • Синхронный вывод
      • Асинхронный вывод
      • Получение информации о выводе
    • Счета
      • Создание счета на оплату
      • Запрос получения информации об инвойсе
      • Получение списка счетов
    • Авто обмены
      • Создание авто-обмена
      • Поиск авто-обмена по ID
    • Выплаты 2.0
      • Создание авто-вывода
      • Поиск авто-вывода по ID
      • Дополнительное подтверждение вывода
    • Мост
      • Получение лимиов для кроссчейн перевода
      • Получение информации о кроссчейн переводе
      • Формирование токена комисси
      • Создание кроссчейн перевода
    • Обмены
      • Получение лимитов для кроссчейн обмена
      • Получение информации о кроссчейн обмене
      • Формирование токена комисси
      • Создание кроссчейн обмена
    • Рекуррентные платежи
      • Создание платежной связки
      • Получение платежной связки
      • Получение платежных связок по пользователю
      • Отключение платежной связки
      • Создание подписки
      • Получение подписки
      • Отключение подписки
      • Создание платежа
    • KYT
      • Проверка рисков транзакции
      • Проверка рисков вывода
      • Проверка риска вывода на указанный адрес
    • Партнерское API
      • Создание пользователя
      • Получение пользователя
      • Получение всех пользователей
      • Создание организации
      • Получение списка организаций
      • Получение авансовых балансов пользователя
      • Пополнение авансового баланса пользователя
      • Получение общих тарифов
      • Создание/обновление индивидуального тарифа
      • Получение индвидуальных тарифов
      • Создание API ключа
      • Получение API ключей
      • Удаление API ключа
    • Вебхуки
      • Получение вебхука
      • Получение вебхука (расширенный)
    • Сиротские транзакции
      • Получение транзакции
      • Получение списка транзакций
      • Получение токена комиссии
      • Вывод
    • Адресная книга
      • Добавление адреса
      • Удаление адреса
      • Обновление адреса
      • Получение списка адресов
Powered by GitBook
On this page
  • Описание
  • Приема оплат
  • Выплаты
  • Подключение
  • Доступные параметры
  • Параметры для приема платежей с помощью счетов
  • Параметры для оплаты персональным адресом

Виджет приема оплаты

PreviousIFrame ордерNextTelegram MiniApp

Last updated 4 months ago

Описание

Виджет позволяет настроить прием платежей с минимальной интеграцией. С вашей стороны необходимо будет настроить прием вебхуков и разместить виджет на странице своего приложения.

Приема оплат

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

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

Счета

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


Персональные адреса

Прием платежей позволяет формировать список крипто адресов под каждого плательщика. Эти адреса навсегда закрепляются за пользователем.

Выплаты

Через виджет можно осуществляй выплаты.

Подключение

Подключение происходит при помощи HTML-тега <iframe/>

Пример:

<iframe 
    allow="clipboard-read; clipboard-write"
    src="https://widget.onchainpay.io/181a197e-3b00-4359-8298-6097aeb52c69"
></iframe>

Атрибут allow="clipboard-read; clipboard-write" необходим чтобы ваши клиенты могли скопировать адрес платежа нажатием кнопки "Скопировать"

Доступные параметры

Параметры передаются в query

Для вставки данных в query их необходимо экранировать. В JavaScript это можно сделать с помощью функции encodeURIComponent

const payinCryptoInvoiceId = encodeURIComponent('#12345');

Параметры для приема платежей с помощью счетов

Параметр
Пример
Описание

payinCryptoInvoiceAmount

(decimal) 123.45

Сумма к оплате

payinCryptoInvoiceCurrencies

(string) USD,EUR

Валюта к пересчету

payinCryptoInvoiceId

(string) #12345

Идентификатор платежа

payinCryptoInvoiceDesc

(string) Оплата платежа 12345

Описание платежа

payinCryptoCurrenciesTo

(string) USDT_bsc,BNB,USDD_tron

Список монет доступных для оплаты

extUserId

(string) user1234567

ID плательщика на стороне мерчанта

Если не передать параметр payinCryptoInvoiceCurrencies, то пользователю будет предложен выбор из всех доступных валют для пересчета его суммы

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

Можно передать одну валюту, тогда она будет выбрана, без возможности для смены пользователем

Параметр payinCryptoInvoiceAmount будет работать если в payinCryptoInvoiceCurrencies передана одна валюта

В параметр можно указывать несколько монет/сетей через запятую

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

Доступно указание монеты в конкретной сети, разделитель - нижнее подчеркивание Пример: USDT_tron,BNB_bsc,ETH_ethereum

При указании параметр payinCryptoInvoicePayerEmailRequired=true поле payinCryptoInvoicePayerEmailAllow игнорируется

При указании параметра extUserId резервируется персональный адрес для указанного пользователя, при этом задействуется функционал счетов. Если указанного персонального пользователя нет, то он будет создан


Параметры для оплаты персональным адресом

Параметр
Пример
Описание

extUserId

(string) user1234567

ID плательщика на стороне мерчанта (параметр обязательный)

Создаваемые персональные пользователи из виджетов будут изолированны между виджетами

Если получить адрес оплаты для пользователя X из виджета A, то он не будет таким же как для того же пользователя X из виджета B


Если вы хотите получить пользователя X через API персональных платежей, то вы должны добавить ID виджета в начало

Пользователь X: user12345 ID виджета: 00000000-0000-0000-0000-000000000000

ID клиента для получения через API будет таким: 00000000-0000-0000-0000-000000000000@user12345

Вебхук при оплате счета
Вебхук при пополнении персонального адреса