Returns whether a settlement run you triggered for a merchant has finished.

GET /api/transactions/settlements/run-state deprecated

Requires: Transactions.Settlement.View, merchant scope.

Requires API key scope: admin (Administration)

Call this after triggering settlement for one merchant, with that merchant's id and the `runId` the trigger returned. Both parameters are required. The close runs each processor in parallel, so a final outcome for one processor does not mean the run is done. `Finished` is reported only when the whole run has ended and none of its batches is still pending; read the recent outcomes after that. Poll with a bounded wait. `Running` means keep waiting. `Unknown` is not a verdict: the run could not be found or read, or it has ended and none of its batches is visible among the merchant's batches from the last 48 hours. A run id that names no run triggered for this merchant (a mistyped id, or the id of a scheduled or all-merchant run) reads as `Unknown` rather than as not found, so stop polling once the run's expected duration has passed and read the recent outcomes instead. 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/run-state?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RunId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/transactions/settlements/run-state?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RunId=3fa85f64-5717-4562-b3fc-2c963f66afa6' `
    -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.settlementGetSettlementRunState("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/settlements/run-state?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RunId=3fa85f64-5717-4562-b3fc-2c963f66afa6', {
  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.SettlementGetSettlementRunStateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/transactions/settlements/run-state?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RunId=3fa85f64-5717-4562-b3fc-2c963f66afa6");
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_settlement_run_state("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/transactions/settlements/run-state?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6&RunId=3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

MerchantId required

query

string (uuid)

The merchant the run was triggered for. Required.

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

query

string (uuid)

The run id the settlement trigger for this merchant returned. Required.

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: SettlementRunStateDto SettlementRunStateDto Each item has these fields.

Field Type Description

merchantId required

string (uuid)

The merchant the run was triggered for.

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 run the state is about.

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.

state required

SettlementRunState SettlementRunState

Whether the run is still going, has finished, or could not be determined. Only `Finished` means every settlement batch the run will produce has reached its final status.

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.

`Running`	The run's workflow is still going, or it has finished and a batch it wrote still reads as pending. Its outcome is not final yet.
`Finished`	The run's workflow has ended and none of its batches is still pending, so its settlement batches are final.
`Unknown`	The state could not be determined. Either the run could not be found or read, or it has ended and none of its batches is visible among the merchant's batches from the last 48 hours. A run id the server does not recognize (a mistyped id, or the id of a scheduled or all-merchant run) reads as Unknown rather than as not found, so Unknown is not a verdict: keep polling only up to the run's expected duration, then stop and read the recent outcomes instead.

queriedAtUtc required

string (date-time)

When the state was read, in UTC.

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.

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 whether a settlement run you triggered for a merchant has finished.

Example request

Parameters

Request body

Responses

Errors

Authentication