Статистика
Раздел содержит инструкции для получения сводной (агрегированной) информации о принятых платёжах.
JSON API
Протокол PayKeeper предназначен для полностью автоматического управления приёмом платежей. С помощью данного протокола можно в автоматическом режиме производить отправку счетов, совершать возвраты, узнавать статус платежей и т.д.
Для решения самых сложных задач
Мы рекомендуем использовать его в случае необходимости интеграции с биллинговыми или бухгалтерскими системами, самописными, либо сильно измененными CMS системами, мобильными приложениями и другими системами, когда применения базовых средств интеграции недостаточно.
JSON-запросы выполняются на сервер, на котором расположен PayKeeper. Каждый запрос должен иметь заголовок Authorization: Basic для Basic HTTP-авторизации.
Для POST-запросов должен передаваться заголовок Content-Type: application/x-www-form-urlencoded.
Платежи
Раздел предназначен для получения информации о платёжах, загрузки различных реестров платежей с применением
разнообразной фильтрации, осуществления поиска, подтверждения списаний, а также полного или частичного возврата
платежей.
Счета
Раздел может быть использован для автоматизации выставления счетов, генерации прямых ссылок на оплату для
отображения в личном кабинете, отправки на e-mail, в мессенджеры, в SMS или соцсети.
Информация о системе
Раздел содержит примеры запросов для получения информации о пользователе и юридическом лице, а также для
получения настроек системы.
Модификация настроек
Раздел позволяет менять глобальные настройки системы для случаев, когда необходимо продублировать их функционал
для сторонней информационной системы предприятия.
Безопасность и авторизация
Раздел содержит информацию об использовании токена авторизации для выполнения запросов к JSON API.
Экспорт данных
Раздел информирует о способе выгрузки данных о платёжах в виде CSV-файла.
Работа с чеками 54-ФЗ
Раздел содержит описания запросов, позволяющих получать информацию о чеках, производить поиск чека по номеру
платёжа и фискальным атрибутам.
Привязка карты
Раздел разъясняет принцип работы опции по привязке карты, включает в себя примеры формы для создания привязки
карты, а также пример отображения итоговой формы.
Любые запросы на чтение данных выполняются GET запросами, на изменение данных на сервере или совершение каких-либо действий POST запросами. Для подписи POST запросов используется специально сгенерированный token (Подробнее в разделе Токен безопасности.)
В случае успешного выполнения запроса возвращается JSON кодированный объект:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
[ { "id":"97452", "pay_amount":"1.00", "refund_amount":"0.00", "clientid":"Ivan Ivanov", "orderid":null, "payment_system_id":"3", "unique_id":null, "status":"success", "repeat_counter":"0", "pending_datetime":"2014-05-14 15:59:00", "obtain_datetime":"2014-05-14 15:59:01", "success_datetime":"2014-05-14 15:59:01" }, ... ] |
В случае логической ошибки в ответе возвращается объект ошибки:
|
1 2 3 4 |
{ "result":"fail", "msg":"Error description" } |
Объект ошибки содержит два поля – result, всегда равное fail, и поле msg со словесным пояснением причины ошибки для отображения пользователю.
Примеры использования JSON API протокола:
Получение ссылки на оплату
Функция будет полезна для реализации мобильного приложения, работы биллинга или любой другой сложной информационной системы подразумевающий отправку счетов при помощи собственных интерфейсов.
Отправка счёта 1С
Инструкция по автоматизации процесса выставления счетов из 1С Бухгалтерии при помощи JSON API от PayKeeper.
Информация от платформы
Информация о доступных платёжных системах поможет при создании собственного интерфейса для работы с платёжами или автоматических систем для балансировки приёма платежей и повышения отказоустойчивости.
Информация о платежах
Инструкция по получению информации о платёжах и их параметрах при помощи JSON API. Будет полезна в случае создания собственной информационной системы содержащий все данные о проведённых операциях.