Перейти к содержанию

Получить агрегированный отчёт по обработанным транзакциям

Этот метод используется для получения агрегированных отчётов по транзакциям с разбивкой по валютам / типам транзакции / статусам и другим параметрам, указанным в запросе на создание отчёта.

Запрос

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

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

Отправьте POST запрос на {YOUR DWH URL}/api/v2/reports/aggregation со следующими параметрами:
date_from
обязательный
 string
Дата и время начала отчётного периода в указанной временной зоне в формате ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm, например, 2025-10-24T23:13:39+02:00.
date_to
обязательный
 string
Дата и время окончания отчётного периода в указанной временной зоне в формате ISO 8601 YYYY-MM-DDThh:mm:ss±hh:mm, например, 2025-10-25T23:13:39+02:00.
date_type
 string
Тип даты транзакции.

Возможные значения:

created_at – дата создания транзакции (по умолчанию),

paid_at – дата и время завершения транзакции.
group_by
 string
Возможные значения: daily, monthly и null (по умолчанию).
object
Секция параметров и фильтров для группировки транзакций.
merchant_id
 integer / array of integers
Идентификатор или идентификаторы торговцев в системе PSP. Возможные значения:

null (по умолчанию) – без группировки/фильтра по этому параметру,

all – с группировкой по каждому уникальному merchant_id,

{merchant_id} или [{merchant_id1}, {merchant_id2}], например, [1054, 1040] – отчёт будет включать только транзакции указанных торговцев с группировкой по каждому из них.
shop_id
 integer / array of integers
Идентификатор или идентификаторы магазинов в системе PSP. Возможные значения:

null (по умолчанию) – без группировки/фильтра по этому параметру,

all – с группировкой по каждому уникальному shop_id,

{shop_id} или [{shop_id1}, {shop_id2}], например, [1054, 1040] – отчёт будет включать только транзакции указанных магазинов с группировкой по каждому из них.
gateway_type
 string / array of strings
Название шлюза/банка в системе PSP. Значение должно вводиться с учетом регистра. Возможные значения:

null (по умолчанию) – без группировки/фильтра по этому параметру,

all – с группировкой по каждому gateway_type,

{gateway_type} или ["{gateway_type1}", "{gateway_type2}"], например, ["Bogus", "Demo"] – отчёт будет включать только транзакции указанных шлюзов с группировкой по каждому из них.
method_brand
 string / array of strings
Метод, использованный для обработки транзакции, например, credit_card, bank_transfer. Возможные значения:

null (по умолчанию) – без группировки/фильтра по этому параметру,

all – с группировкой по всем доступным методам,

{method_brand} или ["{method_brand1}", "{method_brand2}"]– отчёт будет включать только транзакции указанных методов с группировкой по каждому из них.
country
 string / array of strings
Страна покупателя в формате ISO 3166-1 alpha-2. Возможные значения:

null (по умолчанию) – без группировки/фильтра по этому параметру,

all – с группировкой по каждому уникальному значению параметра,

{country} или ["{country1}", "{country2}"] – отчёт будет включать только транзакции с указанными значениями customer.country с группировкой по каждому из них.
currency
 string / array of strings
Валюта транзакции. Возможные значения:

all (по умолчанию) – с группировкой по каждой валюте,

{ISO 4217 currency code} или ["{currency1}", "{currency2}"] – в отчёт будут включены только транзакции в указанных валютах с группировкой по каждой из них.
type
 string / array of strings
Тип транзакции. Возможные значения:

all (по умолчанию) – с группировкой по каждому типу транзакции,

{transaction_type} или ["{transaction_type1}", "{transaction_type2}"] – в отчёт будут включены транзакции только указанных типов с группировкой по каждому из них. Возможные значения типов транзакций: payment, authorization, capture, void, refund, payout, p2p, chargeback, checkup, tokenization.
token_provider
 string / array of strings
Провайдер, источник токена платежа при проведении транзакции, например, google_pay. Возможные значения:

null – без группировки/фильтра по этому параметру,

empty – в отчёт будут включены только транзакции, обработанные без участия сервиса токенизации (таких как Apple Pay, Google Pay, Samsung Pay, VTS, SCOF),

all – с группировкой по token_provider,

{token_provider} или ["{token_provider1}", "{token_provider2}"] – в отчёт будут включены транзакции только указанных провайдеров с группировкой по каждому из них.
status
 string / array of strings
Статус транзакции. Возможные значения:

all (по умолчанию) – с группировкой по каждому статусу транзакции,

{transaction_status} или ["{status1}", "{status2}"] – в отчёт будут включены транзакции только указанных статусов с группировкой по каждому из них.

Возможные значения статусов транзакций: successful, failed, incomplete, expired.
recurring_type
 string / array of strings
Рекуррентный тип транзакции. Возможные значения:

null – без группировки/фильтра по этому параметру,

empty – в отчёт будут включены нерекуррентные транзакции (т.е. будут исключены d_moto, рекуррентные и инициализирующие транзакции),

all – с группировкой по типу рекуррентности,

{recurring_type} или ["{recurring_type1}", "{recurring_type2}"]– в отчёт будут включены транзакции только указанных типов рекуррентности с группировкой по каждому из них.

Возможные значения recurring_type: initial, recurring, d_moto.
billing_descriptor
 string
Описание платежа для отображения в выписке. Возможные значения: null – без фильтра по этому параметру, {value} – в отчёт будут включены транзакции только с указанным значением billing_descriptor.
test
 boolean
Признак тестовой транзакции. По умолчанию false, и в отчёт включаются только реальные транзакции. Чтобы получить отчёт только по тестовым транзакциям, укажите значение true.
agent_id
 integer / array of integers
Идентификатор агента, присвоенного шлюзу, обработавшему транзакцию. Возможные значения:

null – без группировки/фильтра по этому параметру,

empty – в отчёт будут включены транзакции, обработанные шлюзами, которым не присвоен агент,

all – с группировкой по каждому значению agent_id,

{agent_id} или [{agent_id1}, {agent_id2}]– в отчёт будут включены транзакции только с указанными agent_id с группировкой по каждому из них.
Пример запроса 
{
    "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"
    }
}

Ответ
object
array
Данные, сгруппированные по параметрам transaction_parameters из запроса, а также по параметрам currency, status и type. Если в запросе был отправлен параметр group_by со значением daily или monthly, данные также будут сгруппированы по дням/месяцам соответственно.
count
 integer
Общее количество транзакций в группе.
currency
по умолчанию
 string
Валюта транзакций в группе.
period
 string
День (YYYY-MM-DD) или месяц (YYYY-MM), за который сгруппированы транзакции в данном объекте.
token_provider
 string
Провайдер, источник токена платежа при проведении транзакции.
status
по умолчанию
 string
Статус транзакции в данной группе.
type
по умолчанию
 string
Тип транзакции в данной группе.
volume
 decimal
Общая сумма транзакций в данной группе в валюте данной группы в основных денежных единицах.
merchant_id
 integer
Идентификатор торговца в системе PSP.
shop_id
 integer
Идентификатор магазина в системе PSP.
gateway_type
 string
Название шлюза/банка в системе PSP.
method_brand
 string
Метод, использованный для обработки транзакции.
country
string
Страна покупателя в формате ISO 3166-1 alpha-2.
recurring_type
 string
Рекуррентный тип транзакции.
agent_id
 integer
Идентификатор агента, присвоенного шлюзу, обработавшему транзакцию.
billing_descriptor
 string
Описание платежа для отображения в выписке.
total_count
обязательный
 integer
Общее количество транзакций в отчёте.
Пример ответа: только параметры транзакции по умолчанию 
{
    "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
    }
}
Пример ответа со всеми параметрами транзакции 
{
    "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
    }
}