01-statistika

1. Статистика

Источник: https://docs.paykeeper.ru/dokumentatsiya-json-api/statistika/

Раздел протокола «Статистика» предназначен для получения сводной (агрегированной) информации о принятых платежах.

Список запросов

URI	Назначение
1.1 /info/systems/list/	Получение списка всех платёжных систем через которые когда-либо проводились платежи
1.2 /info/systems/sums/	Получение баланса платёжных систем за определённый период
1.3 /info/systems/sums/details/	Получение баланса платёжных систем за период, разбитого по временным интервалам
1.4 /info/systems/allsum/	Получение суммарного баланса всех платёжных систем за период
1.5 /info/errors/total/	Получить количество ошибок по группам
1.6 /info/errors/bydate/	Получить количество ошибок по группам за период

---

1.1 Список платёжных систем /info/systems/list/

Тип: GET
Формат: /info/systems/list/

Параметры запроса отсутствуют.

Ответ:

Параметр	Назначение
id	Идентификатор платёжной системы
system_description	Системное название платёжной системы
site_description	Название платёжной системы

Пример:

[
   {"id": "2", "system_description": "AlfaBank", "site_description": "Альфа-Банк"},
   {"id": "6", "system_description": "RS", "site_description": "Русский Стандарт"},
   {"id": "127", "system_description": "TestPayments", "site_description": "Тестовый Платёж"}
]

---

1.2 Баланс платёжных систем /info/systems/sums/

Возвращает сумму принятых платежей по всем платёжным системам за указанный период.

Тип: GET
Формат: /info/systems/sums/?start=2014-04-12&end=2014-05-12

Параметры запроса:

Параметр	Назначение
start	Дата начала периода (YYYY-MM-DD)
end	Дата конца периода (YYYY-MM-DD)

Параметры ответа:

Параметр	Назначение
id	Идентификатор платёжной системы
system_description	Системное название
site_description	Название
success	Сумма платежей со статусом «Совершён»
account	Сумма успешных платежей, принятых к перечислению на расчётный счёт
stuck	Сумма платежей со статусом «Совершён без оповещения»
currency	Валюта

Пример ответа:

[
    {"id": "6", "system_description": "RS", "site_description": "Русский Стандарт",
     "success": "304 755.00", "account": "304 755.00", "stuck": "0.00", "currency": "RUR"},
    {"id": "2", "system_description": "AlfaBank", "site_description": "Альфа-Банк",
     "success": "19 902.00", "account": "19 902.00", "stuck": "0.00", "currency": "RUR"}
]

Если за период по некоторым платёжным системам не было платежей, они в ответ не попадают.

---

1.3 Баланс по временным интервалам /info/systems/sums/details/

Используется для графиков. При интервале <30 дней возвращается сумма платежей за каждый день. При >30 дней — 30 усреднённых точек.

Тип: GET
Формат: /info/systems/sums/details/?start=2014-04-12&end=2014-05-12

Параметры запроса: start, end (YYYY-MM-DD).

Параметры ответа:

Параметр	Назначение
payment_system_id	Идентификатор платёжной системы
label	Название
data	Массив [TIMESTAMP, AMOUNT], где TIMESTAMP — Unix timestamp, AMOUNT — объём за интервал

Пример:

[
    {
      "payment_system_id": "6",
      "label": "Russian Standart Bank",
      "data": [
         [1394380800000, 120],
         [1394467200000, 101],
         [1394553600000, 331],
         [1394640000000, 290],
         [1394726400000, 305],
         [1394812800000, 201]
      ]
    }
]

---

1.4 Суммарный баланс /info/systems/allsum/

Тип: GET
Формат: /info/systems/allsum/?start=2016-04-12&end=2016-05-12

Параметры запроса: start, end.

Параметры ответа:

Параметр	Назначение
success	Сумма платежей со статусом «Совершён»
account	Сумма успешных платежей к перечислению
stuck	Сумма платежей «Совершён без оповещения»

Пример:

[
    {"success": "10932.00", "account": "10932.00", "stuck": "0.00"}
]

---

1.5 Количество ошибок по группам /info/errors/total/

Тип: GET
Формат: /info/errors/total/

Параметры запроса отсутствуют.

Пример ответа:

{
  "total": "759",
  "totalWithGroup": [
    {
      "error_code": "70",
      "total": "240",
      "user_description": "Сетевая ошибка при отправке запроса."
    }
  ]
}

---

1.6 Ошибки по группам за период /info/errors/bydate/

Тип: GET
Формат: /info/errors/bydate/?start=2014-04-12&end=2014-05-12

Параметры запроса: start, end.

Формат ответа аналогичен п. 1.5.