Запросить файл отчета

Этот метод позволяет запросить отчет в формате CSV или XLSX. Ссылка на отчет может быть получена в запросе на получение файла отчета по идентификатору.

Типы отчетов

На данный момент для этого метода доступен следующий тип отчета:

balance_records

Отчет balance_records будет содержать балансовые записи на уровне торговца, магазина или шлюза в зависимости от того, указан ли в запросе merchant_id, shop_id или gateway_id.

Если ни один из параметров merchant_id, shop_id или gateway_id не указан в запросе, отчет будет содержать балансовые записи на уровне PSP.

Запрос

Запрос должен:

иметь авторизацию типа Basic c PSP ID и секретным ключом PSP как имя пользователя и пароль соответственно;
иметь заголовок Content-Type, установленный как application/json;
иметь заголовок Accept, установленный как application/json;
использовать кодировку UTF-8.

Отправьте POST запрос на {YOUR DWH URL}/api/v2/reports со следующими параметрами:

type

обязательный

string
Тип отчета.
Возможное значение:

balance_records.

format

обязательный

string
Формат запрашиваемого отчета. Возможные значения:

csv;
xlsx.

language

string (2)
Язык отчета. Возможные значения:

en (по умолчанию);
ru.

id

string
Идентификатор отчета.

user_id

обязательный

integer
Идентификатор пользователя, который запросил отчет, в системе PSP.

notification_email

string
email пользователя, который запросил отчет.

object

merchant_id	integer Идентификатор торговца в системе PSP. Отчет будет содержать балансовые записи указанного торговца.
shop_id	integer Идентификатор магазина в системе PSP. Отчет будет содержать балансовые записи указанного магазина.
gateway_id	integer Идентификатор шлюза в системе PSP. Отчет будет содержать балансовые записи по указанному шлюзу.
currency обязательный	string (4) Валюта балансовых записей в формате ISO 4217 или код криптовалюты.
date_from обязательный	datetime Дата и время начала отчетного периода в указанной временной зоне в формате ISO 8601 `YYYY-MM-DDThh:mm:ss±hh:mm`, например, `2025-10-24T23:13:39+02:00`.
date_to обязательный	datetime Дата и время окончания отчетного периода в указанной временной зоне в формате ISO 8601 `YYYY-MM-DDThh:mm:ss±hh:mm`, например, `2025-10-25T23:13:39+02:00`.

Пример запроса

{
    "type": "balance_records",
    "language": "en",
    "format": "xlsx",
    "user_id": 1098,
    "notification_email": "test@test.com",
    "request_params": {
        "date_from": "2025-01-01T00:00:00.000000+03:00",
        "date_to": "2025-11-30T23:59:59.999999+03:00",           
        "shop_id": 1673,
        "currency": "USD"
    }
}

Ответ

object

id	string Идентификатор отчета, используемый для получения отчета.
type	string (50) Тип отчета.
format	string Формат отчета, указанный в запросе.
language	string Язык отчета (язык названий колонок в отчете).
created_at	datetime Дата и время создания запроса на отчет.
generated_at	datetime Дата и время создания отчета.
updated_at	datetime Дата и время последнего обновления отчета.
status	string Статус запроса на отчет. Возможные значения: `pending`, `incomplete`, `successful`, `failed`.
request_params	object Объект `request_params` из запроса.

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

{
    "data": {
        "report": {
            "id": "c3050350-358c-4136-9ba2-da187fc443f5",
            "status": "queued",
            "type": "balance_records",
            "format": "xlsx",
            "engine": "oban",
            "attempt": 0,
            "updated_at": "2025-12-15T12:22:38.821314Z",
            "language": "en",
            "user_id": 1098,
            "psp_id": 1,
            "created_at": "2025-12-15T12:22:38.821314Z",
            "generated_at": null,
            "expiry_date": null,
            "file_url": null,
            "notification_email": "test@test.com",
            "request_params": {
                "currency": "USD",
                "date_from": "2024-12-31T21:00:00.000000+00:00",
                "date_to": "2025-11-30T20:59:59.999999+00:00",
                "shop_id": 1673
            }
        }
    }
}