Counts and totals the transactions matching a filter, three ways.

POST /api/transactions/reports/statistics deprecated

Requires: Transactions.Reports, merchant scope.

Folds every transaction matching the filter into count and total amount, grouped by transaction type, by payment type and by result code. The three groupings partition the same rows, so each one sums to the overall figures.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a TransactionStatisticsRequestDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/transactions/reports/statistics" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "filter": {}
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "filter": {}
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/reports/statistics' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, TransactionStatisticsApi } from '@winkpg/winkpg-api';

const api = new TransactionStatisticsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.transactionStatisticsGetStatistics({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "filter": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/reports/statistics', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "minCreationTime": "2026-01-01T00:00:00Z",
    "maxCreationTime": "2026-01-01T00:00:00Z",
    "filter": {}
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new TransactionStatisticsApi(config);
var body = JsonSerializer.Deserialize<TransactionStatisticsRequestDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "filter": {}
    }
    """);

var result = await api.TransactionStatisticsGetStatisticsAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/reports/statistics");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "filter": {}
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.TransactionStatisticsApi(client)
    body = winkpg_api.TransactionStatisticsRequestDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "filter": {}
    })
    result = api.transaction_statistics_get_statistics(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "filter": {}
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/reports/statistics",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)	Optional merchant to restrict the aggregate to. When omitted, the result covers every merchant the caller is entitled to see. A merchant outside the caller's scope yields an empty result rather than an error, because the caller is not entitled to learn whether it exists. nullable
`minCreationTime` required	string (date-time)	Inclusive lower bound on the transaction's creation time, in UTC. nullable
`maxCreationTime` required	string (date-time)	Exclusive upper bound on the transaction's creation time, in UTC. nullable
`filter` required	all of FilterGroup	The filter tree, in the same vocabulary the transaction continuation list accepts, including its virtual fields (`PaymentMethod`, `DisplayGuid`, `EntryMode`, `SettlementBatchId` and the rest), which are resolved server-side exactly as the list resolves them.

This request body has no documented fields.