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

Trigger settlement for a specific merchant.

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.

**Operation ID:** `settlementTriggerForMerchant`

## Authorization

Requires: Transactions.Settlement.Trigger, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Transactions.Settlement.Trigger`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| merchantId | path | yes | string(uuid) | The merchant to settle. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

Optional settlement trigger parameters.

**Content type:** `application/json`

Schema: [`TriggerSettlementRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/TriggerSettlementRequestDto.md)

Properties:
- `merchantId` (string(uuid)) required
- `openBatchId` (string): (nullable)
- `processorKey` (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` (string): (nullable, max length 500)

_Example: Close a merchant's open batches_

Starts a settlement run that closes the merchant's open batch on every active processor. The call returns once the run starts, and the processor submission completes afterward. A run already in progress for the merchant refuses a second one. On the /merchants/{merchantId}/trigger route the merchant in the path replaces the one in the body.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}
```

_Example: Close one processor's open batch_

Closes only the open batch for the named processor and leaves every other processor's batch open. The processor key must match one of the merchant's active processors, or the request is refused and nothing starts.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}
```

**Content type:** `text/json`

Schema: [`TriggerSettlementRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/TriggerSettlementRequestDto.md)

Properties:
- `merchantId` (string(uuid)) required
- `openBatchId` (string): (nullable)
- `processorKey` (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` (string): (nullable, max length 500)

_Example: Close a merchant's open batches_

Starts a settlement run that closes the merchant's open batch on every active processor. The call returns once the run starts, and the processor submission completes afterward. A run already in progress for the merchant refuses a second one. On the /merchants/{merchantId}/trigger route the merchant in the path replaces the one in the body.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}
```

_Example: Close one processor's open batch_

Closes only the open batch for the named processor and leaves every other processor's batch open. The processor key must match one of the merchant's active processors, or the request is refused and nothing starts.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}
```

**Content type:** `application/*+json`

Schema: [`TriggerSettlementRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/TriggerSettlementRequestDto.md)

Properties:
- `merchantId` (string(uuid)) required
- `openBatchId` (string): (nullable)
- `processorKey` (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` (string): (nullable, max length 500)

_Example: Close a merchant's open batches_

Starts a settlement run that closes the merchant's open batch on every active processor. The call returns once the run starts, and the processor submission completes afterward. A run already in progress for the merchant refuses a second one. On the /merchants/{merchantId}/trigger route the merchant in the path replaces the one in the body.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}
```

_Example: Close one processor's open batch_

Closes only the open batch for the named processor and leaves every other processor's batch open. The processor key must match one of the merchant's active processors, or the request is refused and nothing starts.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`TriggerSettlementResponseDto`](https://devportal.demo.winkpg.io/docs/api/models/TriggerSettlementResponseDto.md)

Properties:
- `instanceId` (string): (nullable)
- `correlationId` (string(uuid))
- `runId` (string(uuid))
- `message` (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.

The request body is a TriggerSettlementRequestDto. See the Request body section below for its fields.

These blocks send the Close a merchant's open batches example. The other examples follow under Other request examples.

Starts a settlement run that closes the merchant's open batch on every active processor. The call returns once the run starts, and the processor submission completes afterward. A run already in progress for the merchant refuses a second one. On the /merchants/{merchantId}/trigger route the merchant in the path replaces the one in the body.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}'
```

### PowerShell

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

$body = @'
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}
'@

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

### 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.settlementTriggerForMerchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
});
```

### TypeScript (raw HTTP)

```typescript
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": "00000000-0000-0000-0000-000000000001",
    "reason": "End-of-day close requested by the merchant"
  }),
});

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;
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": "00000000-0000-0000-0000-000000000001",
      "reason": "End-of-day close requested by the merchant"
    }
    """);

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

### C# (raw HTTP)

```csharp
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": "00000000-0000-0000-0000-000000000001",
      "reason": "End-of-day close requested by the merchant"
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.TriggerSettlementRequestDto.from_dict({
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "reason": "End-of-day close requested by the merchant"
    })
    result = api.settlement_trigger_for_merchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "reason": "End-of-day close requested by the merchant"
}

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

## Other request examples

Each example below is one request, shown in every language with the same placeholders.

### Close one processor's open batch

Closes only the open batch for the named processor and leaves every other processor's batch open. The processor key must match one of the merchant's active processors, or the request is refused and nothing starts.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}'
```

#### PowerShell

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

$body = @'
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}
'@

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

#### 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.settlementTriggerForMerchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
});
```

#### TypeScript (raw HTTP)

```typescript
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": "00000000-0000-0000-0000-000000000001",
    "processorKey": "tsys",
    "reason": "Close the card batch ahead of the processor cutoff"
  }),
});

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;
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": "00000000-0000-0000-0000-000000000001",
      "processorKey": "tsys",
      "reason": "Close the card batch ahead of the processor cutoff"
    }
    """);

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

#### C# (raw HTTP)

```csharp
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": "00000000-0000-0000-0000-000000000001",
      "processorKey": "tsys",
      "reason": "Close the card batch ahead of the processor cutoff"
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.TriggerSettlementRequestDto.from_dict({
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "processorKey": "tsys",
      "reason": "Close the card batch ahead of the processor cutoff"
    })
    result = api.settlement_trigger_for_merchant("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "processorKey": "tsys",
  "reason": "Close the card batch ahead of the processor cutoff"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/settlements/merchants/{merchantId}/trigger",
    headers=headers,
    json=body,
)
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.