Request a report file

This method is used to request a report in CSV or XLSX format. A link to the generated report can later be obtained in the response to the Get a report file by ID request.

Report types

At the moment, the following report type is available for this method:

balance_records

balance_records report contains the balance data at the merchant, shop or gateway level depending on whether merchant_id, shop_id or gateway_id are specified in the request.

If none of merchant_id, shop_id or gateway_id are specified, the report will contain balance records at the PSP level.

Request

The requests must:

use HTTP Basic authentication with your PSP ID and secret key as a username and a password respectively;
have the Content-Type header set to application/json;
have the Accept header set to application/json;
be UTF-8 encoded.

Send a POST request to {YOUR DWH URL}/api/v2/reports with the following parameters:

type

required

string (50)
Type of the report.
Possible values:

balance_records.

format

required

string (50)
Format of the requested report. Possible values:

csv;
xlsx.

language

string (2)
Language of the report. Possible values:

en (default);
ru.

string
Report identifier.

user_id

required

integer
Identifier of the backoffice user that requested the report.

notification_email

string
Email address used as the login of the user, corresponding to the submitted user_id.

request_parameters

object

merchant_id	integer Identifier of the merchant. The report will contain balance records for the specified merchant.
shop_id	integer Identifier of the shop. The report will contain balance records for the specified shop.
gateway_id	integer Identifier of the gateway. The report will contain balance records for the specified gateway.
currency required	string (4) Сurrency of the balance records in ISO-4217, or cryptocurrency code.
date_from required	datetime Start date of the reporting period in ISO 8601 format — `YYYY-MM-DDThh:mm:ss±hh:mm`, for example, `2025-10-24T23:13:39+02:00`.
date_to required	datetime End date of the reporting period in ISO 8601 format — `YYYY-MM-DDThh:mm:ss±hh:mm`, for example, `2025-10-25T23:13:39+02:00`.

Request example

{
    "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"
    }
}

Response

data

object

report

object

id	string Identifier of the report used for getting the report.
type	string (50) Report type.
format	string Report format specified in the request.
language	string Report language (language of the column names).
created_at	datetime Date and time when the report request was created.
generated_at	datetime Date and time when the report was generated.
updated_at	datetime Date and time when the report was last updated.
status	string Status of the report request. Possible values: `pending`, `incomplete`, `successful`, `failed`.
request_params	object `request_params` object from the request.

Response example

{
    "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
            }
        }
    }
}