# POST /api/transactions/reports/statistics

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

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.

**Operation ID:** `transactionStatisticsGetStatistics`

## Authorization

Requires: Transactions.Reports, merchant scope.

Required permissions:
- `Transactions.Reports`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The filter tree, in the same vocabulary the transaction continuation list accepts, plus the
optional UTC creation-time bounds and the optional merchant scope.

**Content type:** `application/json`

Schema: `TransactionStatisticsRequestDto`

Properties:
- `merchantId` (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.
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC.
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC.
- `filter` (object): 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.

**Content type:** `text/json`

Schema: `TransactionStatisticsRequestDto`

Properties:
- `merchantId` (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.
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC.
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC.
- `filter` (object): 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.

**Content type:** `application/*+json`

Schema: `TransactionStatisticsRequestDto`

Properties:
- `merchantId` (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.
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC.
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC.
- `filter` (object): 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.

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `TransactionStatisticsDto`

Properties:
- `transactionCount` (integer(int64)): The number of matching transactions folded into the three groupings.
- `totalAmount` (number(double)): The sum of the matching transactions' totals.
- `truncated` (boolean): Whether the scan stopped at `MaxScannedTransactions`  before the filtered set ran out, in which case every figure is over a prefix of that set.
- `byTransactionType` (array<TransactionStatisticsBucketDto>): Count and total per transaction type, keyed by the `TransactionType` member name  (`Sale`, `Authorization`, `Return`, ...), ordered by descending count.
- `byPaymentType` (array<TransactionStatisticsBucketDto>): Count and total per payment method, keyed by the `PaymentMethodsGranular` member name  (`Visa`, `MasterCard`, `Check`, `AlternativePayment`, ...), resolved by  the same rule every transaction read surface uses, ordered by descending count.
- `byResultCode` (array<TransactionStatisticsBucketDto>): Count and total per gateway result, keyed by the `ResultCode` member name (`Ok`,  `Declined`, ...), ordered by descending count. A transaction that recorded no response  at all falls in the bucket keyed `NoResultKey`.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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

```bash
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

```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
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

```typescript
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();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.