Москва: 8 (495) 984-87-51
Санкт-Петербург: 8 (812) 385-75-57
8 (800) 775-37-51Контакт центр

JSON API

Протокол PayKeeper предназначен для полностью автоматического управления приёмом платежей. С помощью данного протокола можно в автоматическом режиме производить отправку счетов, совершать возвраты, узнавать статус платежей и т.д.

Для решения самых сложных задач

Мы рекомендуем использовать его в случае необходимости интеграции с биллинговыми или бухгалтерскими системами, самописными, либо сильно измененными CMS системами, мобильными приложениями и другими системами, когда применения базовых средств интеграции недостаточно.

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

Для POST-запросов должен передаваться заголовок Content-Type: application/x-www-form-urlencoded.

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

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

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

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

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