Skip to content

Get an aggregated report for processed transactions

This method is used to generate aggregated transaction reports with the data grouped by currencies, transaction types, statuses and other filters specified in the request.

Request

The requests must:

Send a POST request to {YOUR DWH URL}/api/v2/reports/aggregation with the following parameters:
date_from
required
 string
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
 string
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.
date_type
 string
Date type.

Possible values:

created_at is the date when the transaction is created (set by default),

paid_at is the date when the transaction is paid.
group_by
 string
Possible values: daily, monthly and null (by default).
object
Object with parameters for filtering and grouping the results in the response.
merchant_id
 integer / array of integers
Merchant identifier(s) in the PSP system. Possible values:

null – no grouping by merchant_id,

all – grouping by merchant_id,

{merchant_id} or [{merchant_id1}, {merchant_id2}], for example, [1054, 1040] – returns transactions with the specified merchant_id values grouped by each unique merchant_id
shop_id
 integer / array of integers
Shop identifier(s) in the PSP system. Possible values:

null – no grouping by shop_id,

all – grouping by shop_id,

{shop_id} or [{shop_id1}, {shop_id2}], for example, [1054, 1040] – returns transactions with the specified shop_id values, grouped by each unique shop_id.
gateway_type
 string / array of strings
Gateway / bank name(s) in the PSP system, case-sensitive. Possible values:

null (default) – no grouping by gateway / bank,

all – grouping by gateway_type, {gateway_type} or ["{gateway_type1}", "{gateway_type2}"], for example, ["Bogus", "Demo"] – returns transactions with the specified gateway_type values grouped by each unique gateway_type.
method_brand
 string / array of strings
Method type used to process the transactions, for example, credit_card, bank_transfer. Possible values:

null (default) – no grouping by method_brand,

all – grouping by method_brand,

{method_brand} or ["{method_brand1}", "{method_brand2}"] – returns transactions with the specified method_brand values, grouped by each unique method_brand.
country
 string / array of strings
Customer's country in the ISO 3166-1 alpha-2 format. Possible values:

null (default) – no grouping by country,

all – grouping by country,

{country} or ["{country1}", "{country2}"] – returns transactions with the specified customer.country values grouped by each unique country.
currency
 string / array of strings
Transaction currency. Possible values:

all (default) – the results will include transactions in all currencies grouped by each unique currency value,

{currency} or ["{currency1}", "{currency2}"] – returns transactions with the specified currency values, grouped by each unique currency.
type
 string / array of strings
Transaction type. Possible values:

all (default) – groups transactions by each unique transaction type,

{transaction_type} or ["{transaction_type1}", "{transaction_type2}"] – returns transactions of the specified types grouped by each unique type.

Possible transaction types: payment, authorization, capture, void, refund, payout, p2p, chargeback, checkup, tokenization.
token_provider
 string / array of strings
Provider, the source of the payment token used for the transaction, for example, google_pay. Possible values:

null – no grouping by token_provider,

empty – returns transactions processed without the participation of token providers (Apple Pay, Google Pay, Samsung Pay, VTS, SCOF),

all – grouping by token_provider,

{token_provider} or ["{token_provider1}", "{token_provider2}"] – returns transactions with the specified token providers grouped by each unique token_provider.
status
 string / array of strings
Transaction status. Possible values:

all (default) – grouping by status,

{status} or ["{status1}", "{status2}"] – returns transactions with the specified statuses grouped by each unique status.

Possible statuses: successful, failed, incomplete, expired.
recurring_type
 string / array of strings
Transaction recurring type. Possible values:

null – no grouping by recurring type,

empty – returns non-recurrent transactions (excludes d_moto, recurring and initial recurring transactions),

all – grouping transactions by recurring_type,

{recurring_type} or ["{recurring_type1}", "{recurring_type2}"]– returns transactions with the specified recurring types grouped by each unique recurring_type.

Possible recurring types: initial, recurring, d_moto.
billing_descriptor
 string
Order description to be displayed in the bank statement. Possible values: null – no filtering by billing_descriptor, {value} – returns transactions with the specified billing descriptor value.
test
 boolean
By default, false and the report includes only real transactions. Set the parameter value to true if you need to receive a report containing only test transactions.
agent_id
 integer / array of integers
Identifier of the agent assigned to the transaction gateway. Possible values:

null – no grouping by agent_id,

empty – the report will include transactions processed by the gateways with no assigned agent,

all – grouping by agent_id,

{agent_id} or [{agent_id1}, {agent_id2}]– returns transactions with the specified agent identifiers grouped by each unique agent_id.
Request example 
{
    "date_from": "2025-04-21T00:00:00",
    "date_to": "2025-05-01T00:00:00",
    "date_type": "paid_at",
    "group_by": "monthly",
    "transaction_parameters": {
        "currency": [
            "EUR",
            "USD"
        ],
        "type": [
            "payment",
            "capture"
        ],
        "status": [
            "successful",
            "failed"
        ],
        "merchant_id": "all"
    }
}

Response
object
array
Report data grouped by the parameters specified in transaction_parameters in the request, as well as by currency, status and type. If group_by was sent in the request with daily or monthly value, the data will also be grouped by days or months respectively.
count
 integer
Number of transactions in the group.
currency
default
 string
Currency of the transactions in the group.
period
 string
Day (YYYY-MM-DD) or month (YYYY-MM) of the transactions in the group.
token_provider
 string
Provider, the source of the payment token used for the transaction.
status
default
 string
Status of the transactions in the group.
type
default
 string
Type of transactions in the group.
volume
 decimal
Total amount of the transactions in the group in main currency units.
merchant_id
 integer
Merchant identifier in the PSP system.
shop_id
 integer
Shop identifier in the PSP system.
gateway_type
 string
Gateway / bank name in the PSP system.
method_brand
 string
Method type used to process the transactions.
country
 string
Customer's country in the ISO 3166-1 alpha-2 format.
recurring_type
 string
Transaction recurring type.
agent_id
 integer
Identifier of the agent assigned to the transaction gateway.
billing_descriptor
 string
Order description to be displayed in the bank statement.
total_count
 integer
Total number of the transactions in the report.
Response example: only default transaction parameters 
{
    "data": {
        "grouped_data": [
            {
                "count": 26,
                "currency": "BRL",
                "status": "successful",
                "type": "payment",
                "volume": 16800.0
            },
            {
                "count": 8,
                "currency": "BYN",
                "status": "successful",
                "type": "payment",
                "volume": 2.5
            },
            {
                "count": 68,
                "currency": "EUR",
                "status": "successful",
                "type": "payment",
                "volume": 2888.24
            },
            {
                "count": 46,
                "currency": "GBP",
                "status": "successful",
                "type": "payment",
                "volume": 2005.99
            },
            {
                "count": 1,
                "currency": "ILS",
                "status": "successful",
                "type": "payment",
                "volume": 100.1
            },
            {
                "count": 77,
                "currency": "USD",
                "status": "successful",
                "type": "payment",
                "volume": 2993.92
            }
        ],
        "total_count": 226
    }
}
Response example with all transaction parameters 
{
    "data": {
        "grouped_data": [
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 9,
                "country": "GB",
                "currency": "EUR",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1199,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1542,
                "status": "successful",
                "type": "payment",
                "volume": 468.67
            },
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 4,
                "country": "GB",
                "currency": "GBP",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1199,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1542,
                "status": "successful",
                "type": "payment",
                "volume": 276.5
            },
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 6,
                "country": "GB",
                "currency": "USD",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1199,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1542,
                "status": "successful",
                "type": "payment",
                "volume": 148.91
            },
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 8,
                "country": "GB",
                "currency": "EUR",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1283,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1932,
                "status": "successful",
                "type": "payment",
                "volume": 342.48
            },
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 7,
                "country": "GB",
                "currency": "GBP",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1283,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1932,
                "status": "successful",
                "type": "payment",
                "volume": 256.97
            },
            {
                "agent_id": 0,
                "billing_descriptor": null,
                "count": 9,
                "country": "GB",
                "currency": "USD",
                "gateway_type": "DemoAcquirer",
                "merchant_id": 1283,
                "method_brand": "credit_card",
                "recurring_type": "",
                "shop_id": 1932,
                "status": "successful",
                "type": "payment",
                "volume": 359.03
            }
        ],
        "total_count": 43
    }
}