Returns a page of settlement batches matching the supplied filters, newest run first.

GET /api/transactions/settlement-reports/history deprecated

Requires: Transactions.Settlement.ViewHistory, merchant scope.

**Required permissions**: `Transactions.Settlement.ViewHistory` **Scope**: merchant

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/settlement-reports/history" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

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

TypeScript (raw HTTP)

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

C# (raw HTTP)

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

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

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name	In	Type	Description
`MerchantId` required	query	string (uuid)
`StartDateUtc` required	query	string (date-time)
`EndDateUtc` required	query	string (date-time)
`TriggerType` required	query	SettlementTriggerType
`Status` required	query	SettlementBatchStatus	Restricts the result to a single settlement outcome.
`Statuses` required	query	array of SettlementBatchStatus	Restricts the result to batches in any of the named outcomes, in one query.
`PaymentType` required	query	PaymentType	Not filterable. Supplying a value is rejected with HTTP 400.
`Processor` required	query	string	Restricts the result to batches produced for one processor.
`MinNetAmount` required	query	number (double)
`MaxNetAmount` required	query	number (double)
`MaxResultCount` required	query	integer (int32)
`ContinuationToken` required	query	string
`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.