Counts the Transactions that match a filter.

POST /api/transactions/list/continuation/count deprecated

No permission required.

Takes the same request body as the continuation list endpoint and returns how many Transactions match it, without returning the records themselves. The count is approximate and is intended to sit alongside a paged list, so treat it as a display figure rather than a reconciliation total.

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 GetTransactionContinuationInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/transactions/list/continuation/count" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "maxResultCount": 50,
  "includeInactive": true
}'

PowerShell

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

$body = @'
{
  "maxResultCount": 50,
  "includeInactive": true
}
'@

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.transactionsGetApproximateTotalCount({
  "maxResultCount": 50,
  "includeInactive": true
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/list/continuation/count', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "maxResultCount": 50,
    "includeInactive": true
  }),
});

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 TransactionsApi(config);
var body = JsonSerializer.Deserialize<GetTransactionContinuationInput>("""
    {
      "maxResultCount": 50,
      "includeInactive": true
    }
    """);

var result = await api.TransactionsGetApproximateTotalCountAsync(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/list/continuation/count");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "maxResultCount": 50,
      "includeInactive": true
    }
    """, 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.TransactionsApi(client)
    body = winkpg_api.GetTransactionContinuationInput.from_dict({
      "maxResultCount": 50,
      "includeInactive": True
    })
    result = api.transactions_get_approximate_total_count(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "maxResultCount": 50,
  "includeInactive": True
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/list/continuation/count",
    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)	nullable
`hppSessionId` required	string (uuid)	When set, restricts results to the transaction (if any) produced by the given Hosted Payment Page session. Matches `SourceData.HppSessionId`. Lets an integrator poll for the transaction created from a known HPP session without subscribing to completion events. nullable
`apiKeyId` required	string (uuid)	When set, restricts results to transactions submitted with the given API key. Matches `SourceData.ApiKeyId`. Backs the per-key usage view on the API key detail surface, and lets an integrator list exactly what one key has transacted. Narrowing only: the caller still sees nothing outside its own tenant / merchant scope. nullable
`reviewDisposition` required	all of FraudReviewDisposition	When set, restricts results to transactions whose manual fraud-review hold currently sits at the given disposition. Matches `FraudReviewData.Disposition`. Backs the review queue (`Pending`) and the dispositioned-history views. Equality-positive: a transaction that was never held has no `FraudReviewData` at all, so it is absent from the index and correctly drops out of every value of this filter. Supply `MerchantId` alongside it to keep the query single-partition and index-served. Matched by strict equality, which relies on every held transaction carrying an explicit disposition (see the invariant on `disposition`). nullable
`maxResultCount` required	integer (int32)
`continuationToken` required	string	nullable
`maxCreationTime` required	string (date-time)	Exclusive upper bound on the transaction's creation time: only transactions created strictly before this instant are returned. Send an ISO-8601 timestamp in UTC. When this is earlier than `minCreationTime` the range is unsatisfiable and an empty page is returned rather than an error. Like every other filter on this request, it must be held constant for the whole continuation sequence: a continuation token is bound to the query that minted it, so changing a bound mid-sequence pages a different query. nullable
`minCreationTime` required	string (date-time)	Inclusive lower bound on the transaction's creation time: only transactions created at or after this instant are returned. Send an ISO-8601 timestamp in UTC. Must be held constant for the whole continuation sequence (see `maxCreationTime`). nullable
`maxModificationTime` required	string (date-time)	nullable
`maxModifitionTime` required	string (date-time)	Deprecated misspelled alias of `maxModificationTime`. nullabledeprecated
`minModificationTime` required	string (date-time)	nullable
`minModifitionTime` required	string (date-time)	Deprecated misspelled alias of `minModificationTime`. nullabledeprecated
`sorting` required	SortDescriptor
`filter` required	FilterGroup
`includeDeleted` required	boolean
`includeInactive` required	boolean
`includeApproxTotalCount` required	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before. nullable

This request body has no documented fields.