Общая информация
Добро пожаловать в документацию API 1Payment.
Base URL
https://api.1payment.comПеред интеграцией получите API key проекта в личном кабинете и изучите формат запроса к API: HTTP-метод, параметры, подпись sign и обработку колбеков.
Справочник
Формат запроса к APIGET, POST, JSON, подпись sign и проверка колбеков.
Коды ошибок (API)error_code в ответах API, включая ошибку подписи.
Коды ошибок (отказы)status_code при отказе банка или платёжной системы.
Типы платежейЗначения payment_type: card, sbp, sberpay и др.
Типы выплатКаналы выплат и параметр payout_type.
Статусы транзакцийSUCCESS, PENDING, FAILURE и коды для возвратов.
Запрос балансаМетод get_balance по проектам партнёра.
Получение курсаМетод get_rate — курс конвертации между валютами проекта.
Создание инвойсаinit_invoice — счёт на оплату и ссылка на форму.
Приём платежей
Выберите канал, подключённый на проекте. Для каждого метода в документации — параметры, подпись, примеры кода и виджет проверки sign.
Карты
Платёж по формеinit_form — редирект плательщика на платёжную форму.
Host2host (GATE)init_payment — списание с карты без редиректа.
ПодпискиРекуррентные списания по token.
Возвратыinit_refund — полный или частичный возврат.
Статус платежаstatus_payment по order_id или user_data.
СБП
Платёж по формеQR и оплата через приложение банка.
Host2host (GATE)Прямая инициация платежа СБП.
ПодпискиРекуррентные платежи СБП.
ВозвратыОформление возврата по СБП.
Статус платежаОпрос статуса операции СБП.
Приём платежей по ссылке
Платёж по формеРедирект на платёжную страницу по ссылке.
Host2host (GATE)Прямая инициация платежа (payment_type=link).
ПодпискиРекуррентные платежи по ссылке.
ВозвратыОформление возврата по каналу link.
Статус платежаОпрос статуса операции (payment_type=link).
ЕРИП
Платёж по формеQR и оплата через ЕРИП.
Host2host (GATE)Прямая инициация платежа ЕРИП.
ПодпискиРекуррентные платежи ЕРИП.
ВозвратыОформление возврата по ЕРИП.
Статус платежаОпрос статуса операции ЕРИП.
СберПей
Платёж по формеРедирект в сценарий СберПей.
Host2host (GATE)App2App и другие сценарии без формы.
ПодпискиПовторные списания СберПей.
ВозвратыВозврат платежа СберПей.
Статус платежаПроверка статуса по API.
Выплаты
Выплата на картуinit_payout с payout_type=card.
PIXinit_payout с payout_type=pix, Tax ID / CPF.
SEPAinit_payout с payout_type=sepa, IBAN и данные получателя.
FPSinit_payout с payout_type=fps, account и sort code.
СБПinit_payout с payout_type=sbp, телефон и bank_id.
Статус выплатыstatus_payout по order_id выплаты.
Как устроена документация
| Раздел на странице метода | Что внутри |
|---|---|
| Принцип работы | Сценарий для бизнеса и пользователя |
| Техническая информация | URL, HTTP-метод, формат тела |
| Параметры запроса | Обязательные и дополнительные поля |
| Формирование подписи | Формула MD5 и виджет проверки |
| Примеры запроса | Node.js, Python, PHP, cURL |
| Уведомления (колбеки) | POST JSON на ваш notify_url |
Подпись запроса и колбеков — в формате запроса к API. На каждой странице операции есть интерактивная проверка sign.