Перейти к содержимому

Основные понятия

Invoise выдаёт клиенту адрес для оплаты и отправляет полученные средства на ваш кошелёк за вычетом комиссии.

Понятие Значение
Аккаунт Пользователь, который входит в платформу и получает доступ к мерчантам и магазинам.
Мерчант Бизнес в Invoise со своими магазинами, командой и условиями.
Магазин Место создания инвойсов и депозитов. У него свои настройки получателя, API-ключи и история операций.
Инвойс Запрос на разовую оплату фиксированной суммы. Создаётся через /invoices.
Депозит Многоразовый адрес для пополнений без фиксированной суммы. Создаётся через /deposits.
Входящий перевод Средства, отправленные плательщиком на адрес инвойса или депозита. Один инвойс можно оплатить несколькими переводами.
Пейаут Перевод полученных средств получателю магазина за вычетом комиссии.

issuance — общее имя ресурса API для инвойса и депозита. Сохраняйте id из ответа на создание как issuance_id для последующих запросов.

Заказ в вашей системе можно связать с инвойсом через external_id. Сам инвойс в Invoise всегда называется инвойсом.

  1. Создайте инвойс или депозит.
  2. Дождитесь address и передайте клиенту вернувшийся payment_url.
  3. Клиент отправит выбранный токен в выбранной сети.
  4. Invoise подтвердит входящий перевод. Когда суммы достаточно, отправит пейаут получателю.

Проверять результат можно GET-запросом или через вебхуки. См. Статус инвойса и депозита.

Инвойс становится funded, когда получена достаточная подтверждённая сумма. Завершение пейаута подтверждается отдельно событием payout.confirmed.

Настройка Для чего нужна
Адрес получателя Кошелёк для EVM-пейаутов. Проверьте, что он поддерживает выбранные сети.
Кошелёк Invoise Вместо адреса магазин может платить в кошелёк Invoise участника аккаунта.
Делегат Необязательный кошелёк под вашим управлением для самостоятельного завершения EVM-инвойсов с оплатой газа. Адрес биржи для этой роли не подходит.

Получателя, делегата и выбор между адресом и кошельком Invoise можно изменить позже через PATCH /shops/{shop_id}. Каждый инвойс и депозит сохраняет получателя и делегата на момент создания, поэтому изменение касается только инвойсов и адресов, созданных после него.

У Solana и Tron свои получатели. См. Solana и Tron.

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

Переводы на депозитный адрес накапливаются до порога автоматического перевода. Частичные оплаты инвойса — до его суммы. Переплата по инвойсу уходит Invoise вместе с комиссией, а не получателю.

Попробовать интеграцию без реальных средств можно в Sandbox.