7. Экспорт данных
В PayKeeper существует возможность выгружать данные о платежах в виде файла. Для этого используется следующий запрос:
| URI | Назначение | |
|---|---|---|
| 7.1 | URI:/export/payments/ | Назначение:Экспорт истории платежей |
| 7.2 | URI:/export/invoices/ | Назначение:Экспорт истории счетов |
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. Параметры запроса | ||
В результате данного запроса веб-сервер сгенерирует файл указанного типа, содержащий платежи, удовлетворяющие заданным условиям.
7.2 Запрос экспорта истории счетов /export/invoices/
Для загрузки файла с историей счетов необходимо выполнить GET-запрос со следующими параметрами:
| Тип | Формат запроса | |
| Параметр | Назначение | |
| Параметр:GET | Назначение:/export/invoices/?start=2014-04-17&end=2014-06-17& status[]=success&status[]=canceled&status[]=failed&from=0&limit=1000 |
|
| 2. | Параметр:start | Назначение:Дата начала периода в формате YYYY-MM-DD |
| 3. | Параметр:end | Назначение:Дата конца периода в формате YYYY-MM-DD |
| 5. | Параметр:status[] | Назначение:Статус счёта. Применяется для фильтрации счетов по статусам. Может принимать значения: ‘created’, ‘paid’, ‘expired’, ‘sent’. Обязательный параметр. |
| 6. | Параметр:from | Назначение:Пропускает первые N значений. Обязательный параметр. |
| 7. | Параметр:limit | Назначение:Количество возвращаемых значений. Обязательный параметр. |
| Таблица 7.1.1. Параметры запроса | ||
В результате данного запроса веб-сервер сгенерирует файл в формате CSV, содержащий счета, удовлетворяющие заданным условиям.
Оставьте заявку
Менеджер перезвонит вам и расскажет про детали подключения
Ваша заявка успешно принята
Что-то пошло не так