PayKeeper JSON API — Обзор
Источник: https://docs.paykeeper.ru/dokumentatsiya-json-api/
Назначение
Протокол PayKeeper предназначен для полностью автоматического управления приёмом платежей. С его помощью можно автоматически выставлять счета, делать возвраты, проверять статусы платежей и т. д.
JSON API рекомендуется использовать при необходимости интеграции с биллинговыми или бухгалтерскими системами, самописными или сильно модифицированными CMS, мобильными приложениями и другими системами, когда базовых методов интеграции недостаточно.
Технические требования
- Авторизация: каждый запрос должен содержать заголовок
Authorization: Basic <base64>(Basic HTTP Authorization) — см. раздел 6. - Content-Type: POST-запросы должны содержать
Content-Type: application/x-www-form-urlencoded. - Методы: GET для чтения, POST — для операций, изменяющих состояние. POST-запросы подписываются token-ом безопасности.
Формат ответа
Успешный запрос
[
{
"id":"97452",
"pay_amount":"1.00",
"refund_amount":"0.00",
"clientid":"Ivan Ivanov",
"orderid":null,
"payment_system_id":"3",
"status":"success"
}
]Ошибка
{
"result":"fail",
"msg":"Error description"
}Поля:
result— всегда"fail"msg— текст ошибки (можно показывать пользователю)
Разделы протокола
| # | Раздел | Файл |
|---|---|---|
| 1 | Статистика | 01-statistika.md |
| 2 | Платежи | 02-platezhi.md |
| 3 | Счета | 03-scheta.md |
| 4 | Информация о системе | 04-nastrojki.md |
| 5 | Модификация настроек | 05-modifikatsiya-nastroek.md |
| 6 | Безопасность и авторизация | 06-token-bezopasnosti.md |
| 7 | Экспорт данных | 07-eksport-dannyh.md |
| 8 | Работа с чеками 54-ФЗ | 08-rabota-s-chekami-54-fz.md |
| 9 | Привязка карты | 09-privyazka-karty.md |
| 10 | Активная метка (ActiveTag) | 10-activetag.md |