Execute a follow-up operation on an existing transaction.

POST /api/transactions/by-merchant/{merchantId}/{transactionId}/operations deprecated

No permission required.

A client disconnect does not cancel an operation once the request has been received.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/transactions/by-merchant/{merchantId}/{transactionId}/operations" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "operationType": {},
  "amount": 0,
  "reason": "",
  "idempotencyKey": "",
  "offlineAdjustment": {},
  "incrementalAuthorization": {},
  "initiationType": {},
  "mitReason": {},
  "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

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

$body = @'
{
  "operationType": {},
  "amount": 0,
  "reason": "",
  "idempotencyKey": "",
  "offlineAdjustment": {},
  "incrementalAuthorization": {},
  "initiationType": {},
  "mitReason": {},
  "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/by-merchant/{merchantId}/{transactionId}/operations' `
    -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.transactionOperationsExecuteOperation("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "operationType": {},
  "amount": 0,
  "reason": "",
  "idempotencyKey": "",
  "offlineAdjustment": {},
  "incrementalAuthorization": {},
  "initiationType": {},
  "mitReason": {},
  "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/by-merchant/{merchantId}/{transactionId}/operations', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "operationType": {},
    "amount": 0,
    "reason": "",
    "idempotencyKey": "",
    "offlineAdjustment": {},
    "incrementalAuthorization": {},
    "initiationType": {},
    "mitReason": {},
    "storedCredentialConsentId": "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<ExecuteTransactionOperationInput>("""
    {
      "operationType": {},
      "amount": 0,
      "reason": "",
      "idempotencyKey": "",
      "offlineAdjustment": {},
      "incrementalAuthorization": {},
      "initiationType": {},
      "mitReason": {},
      "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.TransactionOperationsExecuteOperationAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/by-merchant/{merchantId}/{transactionId}/operations");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "operationType": {},
      "amount": 0,
      "reason": "",
      "idempotencyKey": "",
      "offlineAdjustment": {},
      "incrementalAuthorization": {},
      "initiationType": {},
      "mitReason": {},
      "storedCredentialConsentId": "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.ExecuteTransactionOperationInput.from_dict({
      "operationType": {},
      "amount": 0,
      "reason": "",
      "idempotencyKey": "",
      "offlineAdjustment": {},
      "incrementalAuthorization": {},
      "initiationType": {},
      "mitReason": {},
      "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.transaction_operations_execute_operation("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "operationType": {},
  "amount": 0,
  "reason": "",
  "idempotencyKey": "",
  "offlineAdjustment": {},
  "incrementalAuthorization": {},
  "initiationType": {},
  "mitReason": {},
  "storedCredentialConsentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/by-merchant/{merchantId}/{transactionId}/operations",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`merchantId` required	path	string (uuid)	The merchant that owns the parent transaction. Required so the parent transaction is read directly rather than searched for.
`transactionId` required	path	string (uuid)	The transaction to operate on.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`operationType` required	all of TransactionOperationType	The type of operation to execute (e.g., Refund, Reversal, Void, Capture).
`amount` required	number (double)	Optional amount for partial operations (refund, reversal). What an omitted value means differs by operation, so it is stated per operation rather than as one rule. Conditional: When Amount is not null. Must be > 0. nullable
`reason` required	string	Optional reason or note for the operation. nullable
`idempotencyKey` required	string	Optional caller-supplied idempotency key used to deduplicate a retried operation (reversal, void, capture, refund, repeat, retry) after a network timeout. The key is scoped to a single merchant + transaction + operation: submitting the same operation twice with the same key executes once and the second call returns the original operation's outcome (for a spawning operation, the same child transaction id) instead of re-applying it. Conditional: When IdempotencyKey is not empty. Max length: 128. nullable
`offlineAdjustment` required	all of OfflineAdjustmentFields	Structured field bundle for the `OfflineAdjustment` operation. Required when `operationType` is `OfflineAdjustment`; rejected by the input validator for any other operation type so the wrong shape cannot ride along quietly. Required: When OperationType == OfflineAdjustment. Conditional: When OfflineAdjustment is not null. Conditional: When OperationType != OfflineAdjustment.
`incrementalAuthorization` required	all of IncrementalAuthorizationFields	Structured field bundle for the `IncrementalAuthorization` operation. Required when `operationType` is `IncrementalAuthorization`; rejected by the input validator for any other operation type so the wrong shape cannot ride along quietly. Required: When OperationType == IncrementalAuthorization. Conditional: When IncrementalAuthorization is not null. Conditional: When OperationType != IncrementalAuthorization.
`initiationType` required	all of InitiationType	Classification gate for `Repeat`. The caller must declare whether the new charge is being initiated by the cardholder (CIT: cardholder is present and authorizing this specific re-run) or by the merchant (MIT: under prior consent or as a network resubmission of a declined attempt). Required: When OperationType == Repeat. Conditional: When InitiationType is not null. nullable
`mitReason` required	all of MITReasonCode	MIT reason code (Recurring, UnscheduledCOF, Resubmission, etc.) accompanying `initiationType` when it is `MerchantInitiated`. Required: When OperationType == Repeat and InitiationType == MerchantInitiated. Conditional: When MITReason is not null. nullable
`storedCredentialConsentId` required	string (uuid)	Identifier of the `StoredCredentialConsent` record that authorizes this MIT. Required for non-resubmission MITs (Recurring, UnscheduledCOF, NoShow, DelayedCharge, Installment, Reauthorization, IncrementalAuth). Ignored for `Resubmission`: resubmissions are authorized by card-network resubmission rules rather than by a consent record. nullable

This request body has no documented fields.