---
title: Request a report file
description: 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.
---

[Skip to content](https://help.ecomcharge.com/en/knowledge-base/api-get-request-a-report-file#main-content)

- [English](https://help.ecomcharge.com/en/knowledge-base/api-get-request-a-report-file)
- [Русский](https://help.ecomcharge.com/knowledge-base-ru/api-get-request-a-report-file)

English

Show submenu for translations

[Customer portal](https://help.ecomcharge.com/tickets?hsLang=en)

- [Subscribe to platform updates](https://share-eu1.hsforms.com/1iuchcnmzT9yq2VKMCRdsLwfnh6h)
- [Support & Requests](https://help.ecomcharge.com/en/knowledge-base/support-requests)

Open main navigation

Close main navigation

- [Subscribe to platform updates](https://share-eu1.hsforms.com/1iuchcnmzT9yq2VKMCRdsLwfnh6h)
- [Support & Requests](https://help.ecomcharge.com/en/knowledge-base/support-requests)
- - [English](https://help.ecomcharge.com/en/knowledge-base/api-get-request-a-report-file)
    - [Русский](https://help.ecomcharge.com/knowledge-base-ru/api-get-request-a-report-file)

  English
  
  Show submenu for translations
- [Customer portal](https://help.ecomcharge.com/tickets)
- [eComCharge Blog](https://ecomcharge.com/blog/)

[eComCharge Blog](https://ecomcharge.com/blog/)

 This is a search field with an auto-suggest feature attached.

- There are no suggestions because the search field is empty.

1. [eComCharge knowledge base](https://help.ecomcharge.com/en/knowledge-base?hsLang=en)
2. [PSP API documentation](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en)
3. [Reports (DWH v.2)](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#reports-dwh-v-2)

# 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](https://help.ecomcharge.com/en/knowledge-base/api-get-a-report-file-by-id?hsLang=en) 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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#Basic_authentication_scheme) with [your PSP ID and secret key](https://psp-doc.begateway.com/en/introduction/psp_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. id 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            }        }    }}
```

  

- [Admin Panel User Guide](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#main-content)

    - [Introduction](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#introduction)
    - [Before you start](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#before-you-start)
    - [Users](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#users)
    - [System administration](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#system-administration)
    - [Merchant account management](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#merchant-account-management)
    - [Configuration of payment gateways](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#configuration-of-payment-gateways)
    - [Merchant shop management](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#merchant-shop-management)
    - [Dashboard](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#dashboard)
    - [Configuration of fraud protection services](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#configuration-of-fraud-protection-services)
    - [Transaction management](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#transaction-management)
    - [Subscription management](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#subscription-management)
    - [Transaction reports](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#transaction-reports)
    - [Accounting and financial reports](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#accounting-and-financial-reports)
    - [Finances](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#finances)
    - [Merchant's balance](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#merchants-balance)
    - [Mass payouts to customers](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#mass-payouts-to-customers)
    - [Additional services](https://help.ecomcharge.com/en/knowledge-base/admin-panel-user-guide?hsLang=en#additional-services)
- [Smart Risk and Routing Engine](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#main-content)

    - [Introduction](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#introduction)
    - [Overall service description](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#overall-service-description)
    - [Getting started](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#getting-started)
    - [Smart routing management](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#smart-routing-management)
    - [Settings management](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#settings-management)
    - [Appendix 1: Logical operators](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#appendix-1-logical-operators)
    - [Appendix 2: List of system fields](https://help.ecomcharge.com/en/knowledge-base/smart-risk-and-routing-engine?hsLang=en#appendix-2-list-of-system-fields)
- [PSP API documentation](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#main-content)

    - [Introduction](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#introduction)
    - [Request requirements](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#request-requirements)
    - [HTTP response codes](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#http-response-codes)
    - [PSP ID and Secret Key](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#psp-id-and-secret-key)
    - [Merchants](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#merchants)
    - [Shops](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#shops)
    - [Transactions (DWH v.2)](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#transactions-dwh-v-2)
    - [Transactions (DWH v.1)](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#transactions-dwh-v-1)
    - [Reference](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#reference)
    - [Reports (DWH v.2)](https://help.ecomcharge.com/en/knowledge-base/psp-api-documentation?hsLang=en#reports-dwh-v-2)
- [Video guides](https://help.ecomcharge.com/en/knowledge-base/video-guides?hsLang=en#main-content)

    - [Creating rules in Smart Routing](https://help.ecomcharge.com/en/knowledge-base/video-guides?hsLang=en#creating-rules-in-smart-routing)
    - [Payment Widget customization](https://help.ecomcharge.com/en/knowledge-base/video-guides?hsLang=en#payment-widget-customization)
- [Integrations](https://help.ecomcharge.com/en/knowledge-base/integrations?hsLang=en#main-content)

    - [Active Connectors with PSPs, banks, APM solution providers](https://help.ecomcharge.com/en/knowledge-base/integrations?hsLang=en#active-connectors-with-psps-banks-apm-solution-providers)
- [Release Notes](https://help.ecomcharge.com/en/knowledge-base/release-notes?hsLang=en#main-content)

    - [2025](https://help.ecomcharge.com/en/knowledge-base/release-notes?hsLang=en#2025)
- [Support and Requests](https://help.ecomcharge.com/en/knowledge-base/support-and-requests?hsLang=en)

[![eComCharge\_main logo uncut@3x 1-2](https://help.ecomcharge.com/hs-fs/hubfs/eComCharge_main%20logo%20uncut@3x%201-2.png?width=150&height=77&name=eComCharge_main%20logo%20uncut@3x%201-2.png "eComCharge_main logo uncut@3x 1-2")](https://help.ecomcharge.com/?hsLang=en)

<https://www.linkedin.com/company/ecomcharge/> [mailto:sales@ecomcharge.com](mailto:sales@ecomcharge.com)

© 2026 eComCharge UAB