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

Quick Start (сводка)

Краткая последовательность для приёма первого платежа по API без входа в ЛК.

  1. Получить api_key и signing_secret — при создании кассы (через партнёра/поддержку).
  2. Указать callback_url — в настройках кассы, чтобы получать вебхуки.
  3. Создать платёжPOST /api/v1/payments с заголовками X-API-Key и X-Nonce.
  4. Перенаправить клиента по pay_url из ответа.
  5. Обработать колбэк payment.paid на своём endpoint, проверив X-Signature.
  6. При необходимости проверить статус: GET /api/v1/payments/{paymentID}.

Подробный пошаговый гайд: Быстрый старт.


Настройки кассы

Через PUT /api/v1/terminals/{terminalID} можно настроить (если есть доступ к API кассы):

ПолеТипОписание
callback_urlstringURL для вебхуков
success_redirect_urlstringРедирект после успешной оплаты
fail_redirect_urlstringРедирект после ошибки/истечения
conversion_modestringinstant или scheduled
conversion_timestringВремя конвертации при scheduled
show_platform_brandingbooleanПоказывать брендинг RollyPay на странице оплаты

Идемпотентность

  • Создание платежа: естественный ключ идемпотентности — order_id (один order_id — один платёж).
  • Создание вывода: явный параметр idempotency_key.
  • Защита от повтора запросов: заголовок X-Nonce (уникальный на запрос в течение 10 минут).