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

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

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

 

1.1. Запрос получения списка платежных систем /info/systems/list/

 Для получения списка всех платежных систем необходимо выполнить GET-запрос по URL  без параметров.

Тип Формат запроса
GET /info/systems/list/
Таблица 1.1.1 Параметры запроса списка платежных систем

В ответ возвращается объект следующего вида:

Тип Формат ответа
  Параметр Назначение
1. id Идентификатор платежной системы
2. system_description Системное название платежной системы
3. site_description Название платежной системы
Таблица 1.1.2 Параметры ответа на запрос списка платежных систем

Ответ на запрос состоит из массива объектов. Пример ответа на запрос:

 

1.2. Запрос получения баланса платежных систем /info/systems/sums/

Запрос возвращает сумму принятых платежей по всем платежным системам за указанный период. Для этого необходимо выполнить GET-запрос по URL со указанием даты начала и конца периода.

Тип Формат запроса
GET /info/systems/sums/?start=2014-04-12&end=2014-05-12
  Параметр Назначение
1. start Дата начала периода в формате YYYY-MM-DD
2. end Дата конца периода в формате YYYY-MM-DD
Таблица 1.2.1. Параметры запроса

В ответ возвращается объект следующего вида:

Тип Формат ответа
  Параметр Назначение
1. id Идентификатор платежной системы
2. system_description Системное название платежной системы
3. site_description Название платежной системы
4. success Сумма платежей со статусом «Совершён»
5. account Сумма успешных платежей принятых к перечислению на расчётный счёт
6. stuck Сумма платежей со статусом «Совершён без оповещения»
7. currency Валюта принятых платежей
Таблица 1.2.2. Параметры ответа на запрос

Ответ на запрос состоит из массива объектов. Пример ответа на запрос:

Обратите внимание, что если за указанный период по некоторым платежным системам не было платежей, то в возвращенном ответе данных платежных систем не будет.

 

1.3. Запрос получения баланса платежных систем, разбитого по временным интервалам /info/systems/sums/details/

Запрос служит для получения данных, необходимых для построения графика приема платежей по времени. В случае если задан интервал меньше 30 дней, возвращает сумму платежей принятых за каждый день. Если указанный интервал больше 30 дней, то производит усреднение и выводит результат в виде 30 точек с указанным временем и объемом принятых платежей за этот интервал. Для получения данных необходимо передать GET-запрос по URL со следующими GET-параметрами.

Тип Формат запроса
GET /info/systems/sums/?start=2014-04-12&end=2014-05-12
  Параметр Назначение
1. start Дата начала периода в формате YYYY-MM-DD
2. end Дата конца периода в формате YYYY-MM-DD
Таблица 1.3.1. Параметры запроса

В ответ возвращается массив объектов следующего вида:

Тип Формат ответа
  Параметр Назначение
1. payment_system_id Идентификатор платежной системы
2. label Название платежной системы
3. data Содержит массив составных объектов следующего формата:
[TIMESTAMP,AMOUNT], где
TIMESTAMP – время в секундах в формате Unix Timestamp,
AMOUNT – объем принятых платежей за интервал времени.
Таблица 1.3.2. Параметры ответа на запрос

Пример ответа на запрос:

 

 

1.4. Запрос получения суммарного баланса всех платежных систем /info/systems/allsum/

Запрос возвращает суммарный баланс всех платежных систем за период. В отличие от запроса 1.2, данный запрос не производит детализацию по каждой платежной системе, в ответ на запрос возвращается только суммарное значение по всем платежным системам.

Для получения ответа на запрос необходимо выполнить GET-запрос по URL со следующими GET-параметрами.

Тип Формат запроса
GET /info/systems/allsum/?start=2016-04-12&end=2016-05-12
  Параметр Назначение
1. start Дата начала периода в формате YYYY-MM-DD
2. end Дата конца периода в формате YYYY-MM-DD
Таблица 1.4.1. Параметры запроса

В ответ возвращается объект следующего вида:

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

Пример ответа на запрос:

 

Запросы 1.* и личный кабинет PayKeeper

Многие протокольные запросы используются в личном кабинете PayKeeper. Чтобы назначение запросов было более наглядным на приведенном ниже скриншоте отмечено какие запросы используются в личном кабинете для получения данных.

Личный кабинет PayKeeper — Раздел статистика