Rolls up the window's transactions by payment type.

GET /api/transactions/reports/paytype-summary deprecated

Requires: Transactions.Reports.Summary, merchant scope.

**Required permissions**: `Transactions.Reports.Summary` **Scope**: merchant

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

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/transactions/reports/paytype-summary' `
    -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.transactionSummaryGetPaymentTypeSummary();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/reports/paytype-summary', {
  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.TransactionSummaryGetPaymentTypeSummaryAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/transactions/reports/paytype-summary");
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.transaction_summary_get_payment_type_summary()

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name	In	Type	Description
`StartDateUtc` required	query	string (date-time)	Start of the reporting window, in UTC. Inclusive: a transaction stamped exactly at this instant is counted.
`EndDateUtc` required	query	string (date-time)	End of the reporting window, in UTC. Exclusive: a transaction stamped exactly at this instant is not counted, so two adjacent windows tile without double-counting the boundary. Must be later than `startDateUtc`, and the window may span at most 366 days: a wider request is rejected with a validation error rather than truncated.
`MerchantId` required	query	string (uuid)	Optional merchant to restrict the aggregate to. When omitted, the result covers every merchant the caller is entitled to see. Supplying a merchant outside the caller's scope yields an empty result rather than an error, because the caller is not entitled to learn whether that merchant exists.
`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.