Paylane
ДокументацияСтатус
ВойтиСоздать аккаунт

Начало работы

  • Обзор
  • Адреса и окружения
  • Авторизация
  • Формат ответа
  • Ошибки
  • Идемпотентность
  • Лимиты

Методы API

  • Методы
  • GET/me
  • GET/currencies
  • POST/invoices
  • GET

Справочник

  • Инвойсы: статусы и жизненный цикл
  • Выводы: статусы
  • Вебхуки
  • Проверка подписи
  • Публичный API страницы оплаты
  • Testnet, mainnet и Simnet

Документы

  • Оферта для мерчантов
  • Политика конфиденциальности
  • AML/KYC-политика
Разделы: Sandbox и тестовые сценарии

Начало работы

  • Обзор
  • Адреса и окружения
  • Авторизация
  • Формат ответа
  • Ошибки

Paylane

Paylane: приём платежей в стейблкоинах

Продукт

ДокументацияСтатусВойтиСоздать аккаунт

Документы

ОфертаКонфиденциальностьAML-политика
/invoices
  • GET/invoices/{id}
  • DELETE/invoices/{id}
  • GET/balance
  • POST/withdrawals
  • GET/withdrawals/{id}
  • GET/stats
  • POST/webhooks/test
  • POST/webhooks/{update_id}/resend
  • POST/sandbox/invoices/{id}/pay
  • POST/sandbox/events
  • Sandbox и тестовые сценарии
    Идемпотентность
  • Лимиты
  • Методы API

    • Методы
    • GET/me
    • GET/currencies
    • POST/invoices
    • GET/invoices
    • GET/invoices/{id}
    • DELETE/invoices/{id}
    • GET/balance
    • POST/withdrawals
    • GET/withdrawals/{id}
    • GET/stats
    • POST/webhooks/test
    • POST/webhooks/{update_id}/resend
    • POST/sandbox/invoices/{id}/pay
    • POST/sandbox/events

    Справочник

    • Инвойсы: статусы и жизненный цикл
    • Выводы: статусы
    • Вебхуки
    • Проверка подписи
    • Публичный API страницы оплаты
    • Testnet, mainnet и Simnet
    • Sandbox и тестовые сценарии

    Документы

    • Оферта для мерчантов
    • Политика конфиденциальности
    • AML/KYC-политика

    Sandbox и тестовые сценарии

    Sandbox это тестовый режим, как test mode у Stripe: интеграция проверяется целиком, без реальных денег и без ожидания блокчейна. Sandbox-приложение это приложение с флагом testnet (ставится при создании в кабинете), его ключи начинаются с pl_test_. Тестовое окружение Paylane: https://api-dev.paylane.pro/api/v1, кабинет https://app-dev.paylane.pro.

    Деньги sandbox не смешиваются с боевыми. Инвойсы, платежи, балансы и выводы sandbox-приложения помечены testnet: true и живут на отдельных счетах леджера и тестовых сетях. Комиссии sandbox идут на отдельный счёт оператора и выручкой не считаются: оператор их не выводит. Токен sandbox-приложения не видит боевые данные, боевой токен не может вызвать /sandbox/... (403 LIVE_MODE).

    Оплата без перевода. POST /sandbox/invoices/{id}/pay или кнопка «Симулировать оплату» на странице pay_url (стрелка рядом открывает остальные сценарии). Платёж проходит по сети sim: Paylane кладёт перевод в уже подтверждённый блок, дальше работает обычный код, поэтому статусы, балансы и вебхуки такие же, как в бою, и подписаны так же. Ответ приходит сразу в статусе paying, итог через секунду. Если сеть у инвойса не выбрана, выбирается sim. Для инвойса в настоящей тестовой сети (Nile, devnet) сценарии недоступны (NOT_AVAILABLE): там платите тестовыми монетами из faucet.

    scenarioЧто происходитСтатус инвойсаВебхуки
    paid (по умолчанию)Перевод остатка суммыpaidinvoice_paying, invoice_paid
    underpaidПеревод половины остатка (ниже допуска недоплаты)partially_paid, при allow_partial: false снова activeinvoice_paying, invoice_partially_paid
    overpaidОстаток плюс 10 %overpaid, излишек в overpaid_amountinvoice_paying, invoice_paid
    expiredСрок инвойса истекает сейчасexpiredinvoice_expired
    droppedПеревод замечен, потом выпал из блока (reorg)paying, затем снова activeinvoice_paying
    lateСрок истекает, потом приходит полная оплатаexpired, при accept_late становится paidinvoice_expired, payment_late (или invoice_paid)

    Сценарии комбинируются: underpaid, затем paid доплачивает остаток. expired и late ждут, пока подтвердится уже отправленный перевод (PAYMENT_IN_FLIGHT).

    Вебхуки. Sandbox-вебхуки уходят тем же конвейером, с тем же порядком доставки, повторами и подписью, что и боевые. Для проверки обработчика: POST /sandbox/events генерирует событие любого типа, POST /webhooks/{update_id}/resend присылает уже отправленное событие ещё раз. В sandbox webhook_url может быть http://; до ноутбука вебхук доходит через туннель (rift, ngrok и т. п.).

    Выводы в sandbox работают как в бою, но без ручной проверки, AML и лимитов: на тестовых сетях настоящими транзакциями, в sim переводом в симулированной сети.

    НазадTestnet, mainnet и Simnet
    Проверка интеграции за минуту
    export API=https://api-dev.paylane.pro/api/v1 TOKEN='pl_test_...'
    ID=$(curl -s "$API/invoices" -H "API-Token: $TOKEN" -H "Content-Type: application/json" \
      -d '{"amount": "25.50", "external_id": "order-1"}' | jq .result.invoice_id)
    curl -s -X POST "$API/sandbox/invoices/$ID/pay" -H "API-Token: $TOKEN" -H "Content-Type: application/json" -d '{"scenario": "paid"}'
    sleep 2; curl -s "$API/invoices/$ID" -H "API-Token: $TOKEN" | jq .result.status   # "paid"
    curl -s "$API/balance" -H "API-Token: $TOKEN"                                      # 25.245 USDT sandbox