# GET /api/transactions/settlements/recent-outcomes Returns the merchant's final settlement batch outcomes, newest first. 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. **Operation ID:** `settlementGetRecentSettlementOutcomes` ## Authorization Requires: Transactions.Settlement.View, merchant scope. Requires API key scope: `admin` Required permissions: - `Transactions.Settlement.View` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | MerchantId | query | no | string(uuid) | The merchant whose recent settlement outcomes should be returned. | | LookbackHours | query | no | 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. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`SettlementRunOutcomesDto`](https://devportal.demo.winkpg.io/docs/api/models/SettlementRunOutcomesDto.md) Properties: - `merchantId` (string(uuid)): The merchant the outcomes belong to. - `queriedAtUtc` (string(date-time)): The instant the lookback window was measured back from, taken once before the read. - `windowStartUtc` (string(date-time)): The start of the window: `QueriedAtUtc` minus the applied lookback. Every item's `CompletedAtUtc` is at or after this instant. - `items` (array<[SettlementRunOutcomeDto](https://devportal.demo.winkpg.io/docs/api/models/SettlementRunOutcomeDto.md)>): Terminal outcomes that completed inside the window, newest `CompletedAtUtc` first. (nullable) Fields of each item: - `settlementBatchId` (string(uuid)): The settlement batch document id, for linking to batch detail. - `runId` (string(uuid)): The settlement run this batch belonged to. - `processorKey` (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) - `openBatchId` (string): The gateway batch id this run settled. Null when the run failed before one existed. (nullable) - `status` ([SettlementBatchStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementBatchStatus.md)): The batch's terminal status. Never `Pending`. Values: - `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` (string): The persisted operator-facing reason (`SettlementBatch.ErrorMessage`). Already sanitized at write time: raw exception text stays in the structured logs. (nullable) - `completedAtUtc` (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. - `triggerType` ([SettlementTriggerType](https://devportal.demo.winkpg.io/docs/api/models/SettlementTriggerType.md)): (nullable) Values: - `Auto` - `Manual` - `correlationId` (string(uuid)): (nullable) - `instanceId` (string): (nullable) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 429 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. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/transactions/settlements/recent-outcomes" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/transactions/settlements/recent-outcomes' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript 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) ```typescript const response = await fetch('{{BASE_URL}}/api/transactions/settlements/recent-outcomes', { method: 'GET', headers: { "api-key": "{{API_KEY}}", }, }); const data = await response.json(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp 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) ```csharp 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(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python 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() ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.