# POST /api/transactions/settlement-override

Apply a manual settlement-status override to one or more transactions.

**Required permissions**: `Transactions.Settlement.Override`  
**Scope**: merchant

**Operation ID:** `transactionSettlementOverrideOverride`

## Authorization

Requires: Transactions.Settlement.Override, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Transactions.Settlement.Override`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

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

Properties:
- `transactionIds` (array<string(uuid)>) required: The transactions to apply the override to. 1 to 200 ids per request. (nullable, max items 200)
- `newStatus` ([SettlementStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementStatus.md)): The settlement status to switch to. Must be admin-targetable.
  Values:
  - `WaitingForSettlement`: Transaction is waiting to be settled with the processor
  - `SettlementSucceeded`: Settlement completed successfully with the processor
  - `SettlementFailed`: Settlement failed - requires review and retry (rollback)
  - `NotEligible`: Transaction is not eligible for settlement (voided, reversed, or not yet captured)
  - `SettlementInProgress`: Settlement is currently in progress with the processor.
  - `SettlementOnHold`: Settlement is on hold and cannot proceed at the moment.
  - `SettlementRolledBack`: Settlement was rolled back or reversed after a completed attempt. Distinct from SettlementFailed which indicates a transient failure needing retry.
  - `ReversalFailed`: A reversal was attempted but the processor did not confirm that the authorization hold was voided: the contributor saw a non-Ok result code (transport failure, timeout, swallowed exception, malformed response, etc.). Distinct from NotEligible (a confirmed reversal/void) and SettlementFailed (a settlement-time failure). Operations need to confirm the hold state with the processor and reverse manually if required. The transaction's Stage is left at the pre-reversal value; the close-stage history entry is NOT written.
  - `Pending`: The provider owns settlement and reports the outcome on its own schedule, so the transaction belongs to no gateway batch. Used for ACH sales and alternative payments. A background sync moves the transaction on as the provider reports, through any of the ACH in-flight statuses, to a terminal status.
  - `Accepted`: The ACH processor has accepted the transaction for processing. VeriCheck V2 only: the entry has been received and accepted by the payment network.
  - `Originated`: The ACH transaction has been originated (submitted to the NACHA network). VeriCheck V2 only: the debit has been forwarded to the RDFI.
  - `Verifying`: The ACH processor is verifying the bank account before origination. VeriCheck V2 only: the check runs on the processor's side, before the debit reaches the ACH network.
  - `PartiallySettled`: The ACH transaction has been partially settled. VeriCheck V2 only: a portion of the funds have cleared.
- `reason` (string) required: Operator-supplied justification. Required, trimmed, 5 to 500 chars. (nullable)

_Example: Mark a transaction as settled_

Sets one transaction's settlement status to SettlementSucceeded, for example after the processor's batch report confirms funding the gateway did not record. The response holds one result per id. The reason is required (5 to 500 characters) and is kept in the audit trail.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}
```

_Example: Put two transactions on hold_

Sets two transactions to SettlementOnHold in one request. Up to 200 ids may be sent. Each id gets its own result: one that cannot take the override is skipped with a reason while the others are applied. Only WaitingForSettlement, SettlementSucceeded, NotEligible, SettlementOnHold and SettlementFailed can be set this way.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}
```

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

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

Properties:
- `transactionIds` (array<string(uuid)>) required: The transactions to apply the override to. 1 to 200 ids per request. (nullable, max items 200)
- `newStatus` ([SettlementStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementStatus.md)): The settlement status to switch to. Must be admin-targetable.
  Values:
  - `WaitingForSettlement`: Transaction is waiting to be settled with the processor
  - `SettlementSucceeded`: Settlement completed successfully with the processor
  - `SettlementFailed`: Settlement failed - requires review and retry (rollback)
  - `NotEligible`: Transaction is not eligible for settlement (voided, reversed, or not yet captured)
  - `SettlementInProgress`: Settlement is currently in progress with the processor.
  - `SettlementOnHold`: Settlement is on hold and cannot proceed at the moment.
  - `SettlementRolledBack`: Settlement was rolled back or reversed after a completed attempt. Distinct from SettlementFailed which indicates a transient failure needing retry.
  - `ReversalFailed`: A reversal was attempted but the processor did not confirm that the authorization hold was voided: the contributor saw a non-Ok result code (transport failure, timeout, swallowed exception, malformed response, etc.). Distinct from NotEligible (a confirmed reversal/void) and SettlementFailed (a settlement-time failure). Operations need to confirm the hold state with the processor and reverse manually if required. The transaction's Stage is left at the pre-reversal value; the close-stage history entry is NOT written.
  - `Pending`: The provider owns settlement and reports the outcome on its own schedule, so the transaction belongs to no gateway batch. Used for ACH sales and alternative payments. A background sync moves the transaction on as the provider reports, through any of the ACH in-flight statuses, to a terminal status.
  - `Accepted`: The ACH processor has accepted the transaction for processing. VeriCheck V2 only: the entry has been received and accepted by the payment network.
  - `Originated`: The ACH transaction has been originated (submitted to the NACHA network). VeriCheck V2 only: the debit has been forwarded to the RDFI.
  - `Verifying`: The ACH processor is verifying the bank account before origination. VeriCheck V2 only: the check runs on the processor's side, before the debit reaches the ACH network.
  - `PartiallySettled`: The ACH transaction has been partially settled. VeriCheck V2 only: a portion of the funds have cleared.
- `reason` (string) required: Operator-supplied justification. Required, trimmed, 5 to 500 chars. (nullable)

_Example: Mark a transaction as settled_

Sets one transaction's settlement status to SettlementSucceeded, for example after the processor's batch report confirms funding the gateway did not record. The response holds one result per id. The reason is required (5 to 500 characters) and is kept in the audit trail.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}
```

_Example: Put two transactions on hold_

Sets two transactions to SettlementOnHold in one request. Up to 200 ids may be sent. Each id gets its own result: one that cannot take the override is skipped with a reason while the others are applied. Only WaitingForSettlement, SettlementSucceeded, NotEligible, SettlementOnHold and SettlementFailed can be set this way.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}
```

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

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

Properties:
- `transactionIds` (array<string(uuid)>) required: The transactions to apply the override to. 1 to 200 ids per request. (nullable, max items 200)
- `newStatus` ([SettlementStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementStatus.md)): The settlement status to switch to. Must be admin-targetable.
  Values:
  - `WaitingForSettlement`: Transaction is waiting to be settled with the processor
  - `SettlementSucceeded`: Settlement completed successfully with the processor
  - `SettlementFailed`: Settlement failed - requires review and retry (rollback)
  - `NotEligible`: Transaction is not eligible for settlement (voided, reversed, or not yet captured)
  - `SettlementInProgress`: Settlement is currently in progress with the processor.
  - `SettlementOnHold`: Settlement is on hold and cannot proceed at the moment.
  - `SettlementRolledBack`: Settlement was rolled back or reversed after a completed attempt. Distinct from SettlementFailed which indicates a transient failure needing retry.
  - `ReversalFailed`: A reversal was attempted but the processor did not confirm that the authorization hold was voided: the contributor saw a non-Ok result code (transport failure, timeout, swallowed exception, malformed response, etc.). Distinct from NotEligible (a confirmed reversal/void) and SettlementFailed (a settlement-time failure). Operations need to confirm the hold state with the processor and reverse manually if required. The transaction's Stage is left at the pre-reversal value; the close-stage history entry is NOT written.
  - `Pending`: The provider owns settlement and reports the outcome on its own schedule, so the transaction belongs to no gateway batch. Used for ACH sales and alternative payments. A background sync moves the transaction on as the provider reports, through any of the ACH in-flight statuses, to a terminal status.
  - `Accepted`: The ACH processor has accepted the transaction for processing. VeriCheck V2 only: the entry has been received and accepted by the payment network.
  - `Originated`: The ACH transaction has been originated (submitted to the NACHA network). VeriCheck V2 only: the debit has been forwarded to the RDFI.
  - `Verifying`: The ACH processor is verifying the bank account before origination. VeriCheck V2 only: the check runs on the processor's side, before the debit reaches the ACH network.
  - `PartiallySettled`: The ACH transaction has been partially settled. VeriCheck V2 only: a portion of the funds have cleared.
- `reason` (string) required: Operator-supplied justification. Required, trimmed, 5 to 500 chars. (nullable)

_Example: Mark a transaction as settled_

Sets one transaction's settlement status to SettlementSucceeded, for example after the processor's batch report confirms funding the gateway did not record. The response holds one result per id. The reason is required (5 to 500 characters) and is kept in the audit trail.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}
```

_Example: Put two transactions on hold_

Sets two transactions to SettlementOnHold in one request. Up to 200 ids may be sent. Each id gets its own result: one that cannot take the override is skipped with a reason while the others are applied. Only WaitingForSettlement, SettlementSucceeded, NotEligible, SettlementOnHold and SettlementFailed can be set this way.

```json
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}
```

## Responses

### 200

OK

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

Schema type: `array<[SettlementOverrideAttemptResult](https://devportal.demo.winkpg.io/docs/api/models/SettlementOverrideAttemptResult.md)>`

Item properties:
- `transactionId` (string(uuid))
- `succeeded` (boolean): True when the override was applied and persisted.
- `previousStatus` ([SettlementStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementStatus.md)): The status the transaction held immediately before the override (or null when it could not be loaded). (nullable)
  Values:
  - `WaitingForSettlement`: Transaction is waiting to be settled with the processor
  - `SettlementSucceeded`: Settlement completed successfully with the processor
  - `SettlementFailed`: Settlement failed - requires review and retry (rollback)
  - `NotEligible`: Transaction is not eligible for settlement (voided, reversed, or not yet captured)
  - `SettlementInProgress`: Settlement is currently in progress with the processor.
  - `SettlementOnHold`: Settlement is on hold and cannot proceed at the moment.
  - `SettlementRolledBack`: Settlement was rolled back or reversed after a completed attempt. Distinct from SettlementFailed which indicates a transient failure needing retry.
  - `ReversalFailed`: A reversal was attempted but the processor did not confirm that the authorization hold was voided: the contributor saw a non-Ok result code (transport failure, timeout, swallowed exception, malformed response, etc.). Distinct from NotEligible (a confirmed reversal/void) and SettlementFailed (a settlement-time failure). Operations need to confirm the hold state with the processor and reverse manually if required. The transaction's Stage is left at the pre-reversal value; the close-stage history entry is NOT written.
  - `Pending`: The provider owns settlement and reports the outcome on its own schedule, so the transaction belongs to no gateway batch. Used for ACH sales and alternative payments. A background sync moves the transaction on as the provider reports, through any of the ACH in-flight statuses, to a terminal status.
  - `Accepted`: The ACH processor has accepted the transaction for processing. VeriCheck V2 only: the entry has been received and accepted by the payment network.
  - `Originated`: The ACH transaction has been originated (submitted to the NACHA network). VeriCheck V2 only: the debit has been forwarded to the RDFI.
  - `Verifying`: The ACH processor is verifying the bank account before origination. VeriCheck V2 only: the check runs on the processor's side, before the debit reaches the ACH network.
  - `PartiallySettled`: The ACH transaction has been partially settled. VeriCheck V2 only: a portion of the funds have cleared.
- `newStatus` ([SettlementStatus](https://devportal.demo.winkpg.io/docs/api/models/SettlementStatus.md)): The status the transaction holds after the override (null when the override did not apply). (nullable)
  Values:
  - `WaitingForSettlement`: Transaction is waiting to be settled with the processor
  - `SettlementSucceeded`: Settlement completed successfully with the processor
  - `SettlementFailed`: Settlement failed - requires review and retry (rollback)
  - `NotEligible`: Transaction is not eligible for settlement (voided, reversed, or not yet captured)
  - `SettlementInProgress`: Settlement is currently in progress with the processor.
  - `SettlementOnHold`: Settlement is on hold and cannot proceed at the moment.
  - `SettlementRolledBack`: Settlement was rolled back or reversed after a completed attempt. Distinct from SettlementFailed which indicates a transient failure needing retry.
  - `ReversalFailed`: A reversal was attempted but the processor did not confirm that the authorization hold was voided: the contributor saw a non-Ok result code (transport failure, timeout, swallowed exception, malformed response, etc.). Distinct from NotEligible (a confirmed reversal/void) and SettlementFailed (a settlement-time failure). Operations need to confirm the hold state with the processor and reverse manually if required. The transaction's Stage is left at the pre-reversal value; the close-stage history entry is NOT written.
  - `Pending`: The provider owns settlement and reports the outcome on its own schedule, so the transaction belongs to no gateway batch. Used for ACH sales and alternative payments. A background sync moves the transaction on as the provider reports, through any of the ACH in-flight statuses, to a terminal status.
  - `Accepted`: The ACH processor has accepted the transaction for processing. VeriCheck V2 only: the entry has been received and accepted by the payment network.
  - `Originated`: The ACH transaction has been originated (submitted to the NACHA network). VeriCheck V2 only: the debit has been forwarded to the RDFI.
  - `Verifying`: The ACH processor is verifying the bank account before origination. VeriCheck V2 only: the check runs on the processor's side, before the debit reaches the ACH network.
  - `PartiallySettled`: The ACH transaction has been partially settled. VeriCheck V2 only: a portion of the funds have cleared.
- `skipReason` (string): Stable diagnostic code populated when `succeeded` is false. Values are  drawn from `SettlementOverrideSkipReasons`. (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 SettlementOverrideRequestDto. See the Request body section below for its fields.

These blocks send the Mark a transaction as settled example. The other examples follow under Other request examples.

Sets one transaction's settlement status to SettlementSucceeded, for example after the processor's batch report confirms funding the gateway did not record. The response holds one result per id. The reason is required (5 to 500 characters) and is kept in the audit trail.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/settlement-override" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}'
```

### PowerShell

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

$body = @'
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/settlement-override' `
    -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.transactionSettlementOverrideOverride({
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/transactions/settlement-override', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "transactionIds": [
      "00000000-0000-0000-0000-000000000abc"
    ],
    "newStatus": "SettlementSucceeded",
    "reason": "Funding confirmed on the processor batch report"
  }),
});

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<SettlementOverrideRequestDto>("""
    {
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc"
      ],
      "newStatus": "SettlementSucceeded",
      "reason": "Funding confirmed on the processor batch report"
    }
    """);

var result = await api.TransactionSettlementOverrideOverrideAsync(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/settlement-override");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc"
      ],
      "newStatus": "SettlementSucceeded",
      "reason": "Funding confirmed on the processor batch report"
    }
    """, 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.SettlementOverrideRequestDto.from_dict({
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc"
      ],
      "newStatus": "SettlementSucceeded",
      "reason": "Funding confirmed on the processor batch report"
    })
    result = api.transaction_settlement_override_override(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc"
  ],
  "newStatus": "SettlementSucceeded",
  "reason": "Funding confirmed on the processor batch report"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/settlement-override",
    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.

### Put two transactions on hold

Sets two transactions to SettlementOnHold in one request. Up to 200 ids may be sent. Each id gets its own result: one that cannot take the override is skipped with a reason while the others are applied. Only WaitingForSettlement, SettlementSucceeded, NotEligible, SettlementOnHold and SettlementFailed can be set this way.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/settlement-override" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}'
```

#### PowerShell

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

$body = @'
{
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/settlement-override' `
    -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.transactionSettlementOverrideOverride({
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/transactions/settlement-override', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "transactionIds": [
      "00000000-0000-0000-0000-000000000abc",
      "00000000-0000-0000-0000-000000000abd"
    ],
    "newStatus": "SettlementOnHold",
    "reason": "Held while a funding discrepancy is investigated"
  }),
});

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<SettlementOverrideRequestDto>("""
    {
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc",
        "00000000-0000-0000-0000-000000000abd"
      ],
      "newStatus": "SettlementOnHold",
      "reason": "Held while a funding discrepancy is investigated"
    }
    """);

var result = await api.TransactionSettlementOverrideOverrideAsync(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/settlement-override");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc",
        "00000000-0000-0000-0000-000000000abd"
      ],
      "newStatus": "SettlementOnHold",
      "reason": "Held while a funding discrepancy is investigated"
    }
    """, 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.SettlementOverrideRequestDto.from_dict({
      "transactionIds": [
        "00000000-0000-0000-0000-000000000abc",
        "00000000-0000-0000-0000-000000000abd"
      ],
      "newStatus": "SettlementOnHold",
      "reason": "Held while a funding discrepancy is investigated"
    })
    result = api.transaction_settlement_override_override(body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "transactionIds": [
    "00000000-0000-0000-0000-000000000abc",
    "00000000-0000-0000-0000-000000000abd"
  ],
  "newStatus": "SettlementOnHold",
  "reason": "Held while a funding discrepancy is investigated"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/settlement-override",
    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.