Get a report file by ID
To get the status and a link to the report file in CSV or XLSX format, send a GET request to {YOUR DWH URL}/api/v2/reports/{report_id}, where {report_id} stands for identifier assigned by the PSP system to the requested report. The report identifier can be obtained in a successful response to the report request.
Response
Response example{
"data": {
"report": {
"id": "c3050350-358c-4336-9ba2-da187fc443f5",
"status": "successful",
"type": "balance_records",
"format": "xlsx",
"engine": "oban",
"attempt": 1,
"updated_at": "2025-12-15T12:22:38.821314Z",
"language": "en",
"user_id": 1098,
"created_at": "2025-12-15T12:22:38.821314Z",
"psp_id": 1,
"generated_at": "2025-12-15T12:22:55.605715Z",
"expiry_date": "2025-12-18T12:22:55.618136Z",
"file_url": "https://s3.eu-west-1.amazonaws.com/wlsexports-test/app/local_vol/reports/c3050350-358c-4136-9ba2-da187fc443f5/report_balance_records_202412312100_202511302059_c3050350.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJBYIPDD7GHCZUBWQ%2F20251215%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20251215T122255Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=77e5f4e97f8544e26f90c75877df81167871b09736524f3110eabea1aa270f17",
"notification_email": "test@test.com",
"request_params": {
"currency": "USD",
"shop_id": 1673,
"date_from": "2024-12-31T21:00:00.000000Z",
"date_to": "2025-11-30T20:59:59.999999Z"
}
}
}
}
Report structure
balance_records report structure
Balances are the total amount of all pay-in transactions (payments, captures) minus the tptal amount of payouts, refunds, chargebacks, rolling reserve, rates and adjustments.
The report contains two sheets: balance_records and opening_balance.
balance_records
| Column name | Column description |
| Merchant ID | Merchant identifier in the PSP system. |
| Merchant name | Merchant company name in the PSP system. |
| Shop ID | Shop identifier in the PSP system. |
| Shop name | Shop name in the PSP system. |
| Gateway ID | Identifier of the shop gateway in the PSP system. |
| Transaction UID | Transaction identifier in the PSP system. |
| Transaction type | Transaction type. Balance records are created only for financial transaction types. |
| Transaction status | Transaction status. Balance records are created only for the transactions with final statuses. |
| Balance record ID | Balance record identifier in the PSP system. |
| Creation date | Date and time when the balance record was created in the PSP system. |
| Balance record type | Balance record type in the system. |
| Balance record amount | Balance record amount in minimal currency units. |
| Balance record currency | Balance record currency. |
| Description | Balance record description. |
opening_balance
| Column name | Column description |
| As of date | Date of the beginning of the period for which the balance is calculated. |
| Amount | Balance amount in minimal currency units. |
| Currency | Balance currency. |