7. Экспорт данных

В PayKeeper существует возможность выгружать данные о платежах в виде файла. Для этого используется следующий запрос:

  URI Назначение
7.1 /export/payments/ Экспорт истории платежей

 

7.1 Запрос экспорта истории платежей /export/payments/

Для загрузки файла с историей платежей необходимо выполнить GET-запрос со следующими параметрами:

Тип Формат запроса
GET /export/payments/?type=xlsx&start=2014-04-17&end=2014-06-17&
status[]=success&status[]=canceled&status[]=failed&payment_system_id[]=9&
payment_system_id[]=1&from=0&limit=1000
  Параметр Назначение
1. type Желаемый тип файла для загрузки. Доступные значения: xlsx
2. start Дата начала периода в формате YYYY-MM-DD
3. end Дата конца периода в формате YYYY-MM-DD
4. payment_system_id[] Идентификатор платежной системы. Применяется для фильтрации по платежной системе. Обязательный параметр.
5. status[] Статус платежей. Применяется для фильтрации платежей по статусам. Может принимать значения: ‘pending’, ‘obtained’, ‘canceled’, ‘success’, ‘failed’, ‘stuck’, ‘refunded’, ‘refunding’, ‘partially_refunded’. Обязательный параметр.
6. from Пропускает первые N значений. Обязательный параметр.
7. limit Количество возвращаемых значений. Обязательный параметр.
Таблица 7.1.1. Параметры запроса

В результате данного запроса веб-сервер сгенерирует файл указанного типа, содержащий платежи, удовлетворяющие заданным условиям.