Returns the merchant's final settlement batch outcomes, newest first.

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

Requires: Transactions.Settlement.View, merchant scope.

Requires API key scope: admin (Administration)

Call this to learn what a settlement close actually did. A settlement trigger answers as soon as the run starts, so the result of each processor's batch is read here once the run has finished. When you triggered the run yourself, wait until the run-state read (`GET /api/transactions/settlements/run-state`) reports `Finished`, then call this. `lookbackHours` sets the window in whole hours: 48 when omitted, clamped to 1 through 336. The window is measured back from `queriedAtUtc`, with no rounding to the hour, and applied to each outcome's `completedAtUtc`, the same instant the outcomes are ordered by: a run that started before the window but finished inside it is returned. `windowStartUtc` in the response is the exact cut, and every outcome's `completedAtUtc` is at or after it. A pending batch is not returned, so every outcome is a final status for one processor. That alone does not mean the run has finished: its other batches may not have been written yet. A close that covers several processors writes one outcome per processor, each carrying the trigger's `runId`, so filter by `runId` and expect a set rather than a single outcome. Requires the settlement view permission, and returns data only for a merchant the caller can access.

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

LookbackHours required

query

integer (int32)

How far back to look, in whole hours. The window is a rolling cutoff: the response's `QueriedAtUtc` minus this many hours, with no rounding to the hour, returned as `WindowStartUtc`. It is applied to each outcome's `CompletedAtUtc`, so an outcome is returned when it completed inside the window, whenever its run started. Omit it for the default of 48 hours. Values outside 1 through 336 hours (14 days) are clamped to the nearer bound.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: SettlementRunOutcomesDto SettlementRunOutcomesDto Each item has these fields.

Field Type Description

merchantId required

string (uuid)

The merchant the outcomes belong to.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

queriedAtUtc required

string (date-time)

The instant the lookback window was measured back from, taken once before the read.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

windowStartUtc required

string (date-time)

The start of the window: `QueriedAtUtc` minus the applied lookback. Every item's `CompletedAtUtc` is at or after this instant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

items required

array of SettlementRunOutcomeDto array of SettlementRunOutcomeDto

Terminal outcomes that completed inside the window, newest `CompletedAtUtc` first. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each SettlementRunOutcomeDto:

Field Type Description

settlementBatchId required

string (uuid)

The settlement batch document id, for linking to batch detail.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

runId required

string (uuid)

The settlement run this batch belonged to.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

processorKey required

string

Lower-cased processor key the batch was produced for. Null for legacy rows and for synthetic rows written before a processor could be resolved. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

openBatchId required

string

The gateway batch id this run settled. Null when the run failed before one existed. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

SettlementBatchStatus SettlementBatchStatus

The batch's terminal status. Never `Pending`.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Pending`	Batch created, awaiting processor submission.
`Completed`	Batch successfully settled with the processor.
`Failed`	Batch settlement failed.
`PartiallyCompleted`	Some transactions settled, others rejected by the processor.
`NothingToSettle`	No transactions were eligible to settle for this (merchant, processor) group. A successful no-op outcome, distinct from Failed (a genuine fault) and from Completed (a real settle). Recorded so a settlement run leaves a history row for every targeted (merchant, processor) even when zero transactions are loaded. The short explanation is carried in SettlementBatch.ErrorMessage as the per-batch outcome detail.
`OperatorActionRequired`	The batch could not be settled automatically and is parked for operator action. Distinct from Failed: a Failed closed batch is re-attempted on the next run (transient fault), whereas an OperatorActionRequired batch is deliberately excluded from automatic retry because blindly re-submitting it would just re-fail. Two causes park a batch here: a non-transient duplicate-batch-number processor rejection (the same processor BatchNumber will keep colliding until an operator bumps it), and exhaustion of SettlementConsts.MaxSettlementRetries transient retries. The batch's transactions are moved to SettlementStatus.SettlementOnHold so they stop auto-retrying; the reason is carried in SettlementBatch.ErrorMessage. The operator UI (follow-up story) lists these and can retry with a bumped processor BatchNumber.
`TerminalContention`	The batch was not submitted because a concurrent settlement run already held the terminal lock for the same (Fiserv MerchID, TermID) pair (UMF Appendix M 42.1: only one batch at a time per terminal). Distinct from Failed: nothing went wrong, this run simply deferred to the run that already owned the terminal. The next scheduled run retries normally.

errorMessage required

string

The persisted operator-facing reason (`SettlementBatch.ErrorMessage`). Already sanitized at write time: raw exception text stays in the structured logs. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

completedAtUtc required

string (date-time)

When the batch reached its terminal state, falling back to its creation time when the batch has no recorded completion time. The lookback window and the newest-first order both use this value.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

triggerType required

SettlementTriggerType SettlementTriggerType

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Auto`
`Manual`

correlationId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

instanceId required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Transactions

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Returns the merchant's final settlement batch outcomes, newest first.

Example request

Parameters

Request body

Responses

Errors

Authentication