Документация JSON API

JSON API протокол PayKeeper предназначен для полностью автоматического управления приемом платежей. С помощью данного протокола можно в автоматическом режиме производить отправку счетов, совершать возвраты, узнавать статус платежей и т.д. Мы рекомендуем использовать его в случае необходимости интеграции с биллиногвыми или бухгалтерскими системами, самописными либо сильно измененными CMS системами, мобильными приложениями и другими системами когда применения базовых средств интеграции недостаточно.

JSON-запросы выполняются на сервер, на котором расположен PayKeeper. Каждый запрос должен иметь заголовок Authorization: Basic для Basic HTTP-авторизации.

Для удобства использования протокол JSON API разбит на следующие разделы:

  1. Общая статистика принимаемых платежей по различным платежным системам и датам.
  2. Получение информации о платежах, выполнение полного и частичного возврата платежей.
  3. Работа с реестром платежей с возможностью фильтрации по «Статусам», «Датам», «Платежным системам».
  4. Работа с электронными счетами, выставление счетов на e-mail, дублирование старых счетов.
  5. Работа с реестром электронных счетов, отображение с возможностью фильтрации по датам и статусам.
  6. Изменение внутренней конфигурации системы.

Любые запросы на чтение данных выполняются GET запросами, на изменение данных на сервере или совершение каких-либо действий POST запросами. Для подписи POST запросов используется специально сгенерированный token (Подробнее в разделе Токен безопасности.)

В случае успешного выполнения запроса возвращается JSON кодированный объект:

В случае логической ошибки в ответе возвращается объект ошибки:

Объект ошибки содержит два поля – result, всегда равное fail, и поле msg со словесным пояснением причины ошибки для отображения пользователю.

Примеры использования JSON API протокола:

  1. Получение ссылки на оплату
  2. Отправка счета 1С
  3. Получение информации о подключенных платежных системах
  4. Получение информации о платежах