Trigger settlement for a specific merchant.

POST /api/transactions/settlements/merchants/{merchantId}/trigger deprecated

Requires: Transactions.Settlement.Trigger, merchant scope.

Requires the settlement trigger permission. The merchant in the path overrides any merchant supplied in the body. The call returns as soon as the run starts; the processor submission completes asynchronously.

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 TriggerSettlementRequestDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger' `
    -Headers $headers -ContentType 'application/json' -Body $body

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.settlementTriggerForMerchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new TransactionsApi(config);
var body = JsonSerializer.Deserialize<TriggerSettlementRequestDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.SettlementTriggerForMerchantAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/settlements/merchants/{merchantId}/trigger");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.TriggerSettlementRequestDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.settlement_trigger_for_merchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`merchantId` required	path	string (uuid)	The merchant to settle.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)
`openBatchId` required	string	nullable
`processorKey` required	string	Optional processor key scoping the close to a single processor's open batch. When set, the run fans out only to the matching (merchant, processor) group, leaving every other processor's batch untouched; when null, the historical all-processor behaviour is preserved. Matched case-insensitively against the merchant's active processor keys. nullable
`reason` required	string	nullablemax length 500

This request body has no documented fields.