List transactions

GET /api/transactions deprecated

Requires: Transactions.Reports, merchant scope.

Retrieves a paginated list of transactions with optional filtering and sorting.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/transactions" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/transactions' `
    -Headers $headers

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.transactionsGetList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new TransactionsApi(config);
var result = await api.TransactionsGetListAsync();

C# (raw HTTP)

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

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

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)
    result = api.transactions_get_list()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/transactions",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`MaxCreationTime` required	query	string (date-time)
`MinCreationTime` required	query	string (date-time)
`MaxModificationTime` required	query	string (date-time)
`MaxModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `maxModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`MinModificationTime` required	query	string (date-time)
`MinModifitionTime` required	query	string (date-time)	Deprecated misspelled alias of `minModificationTime`. Deprecated misspelling kept for compatibility. Use MinModificationTime or MaxModificationTime instead. When a request sends both spellings of the same bound, the correctly spelled parameter is used and this one is ignored.
`MerchantId` required	query	string (uuid)	Optional server-side filter on the owning merchant. When set, only transactions whose `MerchantId` equals this value are returned, and `totalCount` reflects that same filtered set rather than the whole estate. A merchant-scoped request is cheaper and faster than an unscoped one. This narrows within the caller's existing access scope and never widens it: a merchant the caller cannot see yields an empty page rather than a leak. `null` leaves the result unfiltered by merchant. Mirrors `GetTransactionContinuationInput.MerchantId` on the continuation list path.
`MerchantIds` required	query	array of string (uuid)	Optional server-side filter restricting the result to several merchants at once. Repeat the parameter to supply more than one value. Behaves as `merchantId` does, except that a transaction matches when its `MerchantId` equals any listed value. Every filter on this request narrows. Supplying this alongside `merchantId` returns only the transactions that satisfy both, so a scalar value absent from this list yields an empty page. A list holding nothing usable fails closed on an empty page too, because a caller that asked to be narrowed must never be widened to the whole estate. `null` or an empty list leaves the result unfiltered by merchant.
`Filter` required	query	string	Gets or sets a general filter string for the result set.
`Name` required	query	string	Gets or sets the name filter for the result set.
`IncludeDeleted` required	query	boolean	Gets or sets a value indicating whether to include deleted entities in the result set.
`IncludeInactive` required	query	boolean	Gets or sets a value indicating whether to include inactive entities in the result set.
`Ids` required	query	array of string (uuid)	Gets or sets a list of entity IDs to filter the result set.
`Sorting` required	query	string
`SkipCount` required	query	integer (int32)
`MaxResultCount` required	query	integer (int32)
`ExtraProperties` required	query	object
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.