Returns the merchant's terminal settlement runs, newest first.

GET /api/transactions/settlements/recent-outcomes deprecated

Requires: Transactions.Settlement.View, merchant scope.

The outcome half of a manual close, over a lookback window the caller chooses. `TriggerAsync` answers "accepted" and nothing more, so a caller that has to report what the close actually did reads it here. The v1 compatibility facade reads it after a `SettleAll` once `GetSettlementRunStateAsync` reports the run finished, because v1's `SettleAll` was synchronous and answered a host result code. A pending batch is not returned, so every row is a final status for one processor. That is not the same as the run having finished: its other batches may not have been written yet. An all-processor close stamps one row per processor, every one carrying the trigger's run id, so a caller correlating by run id gets a set and collapses it itself. Authorization is enforced by the `[Authorize(SettlementPermissions.View)]` on the app-service method and merchant scoping by the repository's own data filters; this controller widens nothing. A GET, so the class-level anti-forgery opt-out is not in play.

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/settlements/recent-outcomes" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/transactions/settlements/recent-outcomes' `
    -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.settlementGetRecentSettlementOutcomes();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/settlements/recent-outcomes', {
  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.SettlementGetRecentSettlementOutcomesAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/transactions/settlements/recent-outcomes");
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_get_recent_settlement_outcomes()

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name	In	Type	Description
`MerchantId` required	query	string (uuid)	The merchant whose recent settlement outcomes should be returned.
`LookbackHours` required	query	integer (int32)	How far back to look. Clamped server-side to a sane maximum so a caller cannot turn this into a full-history scan. Null uses the server default.
`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.