Start a split tender to collect the shortfall on a partial approval.

POST /api/transactions/{id}/partial-approval/split-tender deprecated

Requires: Transactions.PartialApproval.Acknowledge, merchant scope.

The reduced authorization is kept and the transaction becomes the primary tender of a split tender group. The response carries the group identifier and what is still owed. A merchant with split tender turned off is refused with 403 `Transactions:SplitTenderNotEnabled`; the partial approval is left unchanged and can still be accepted or voided. Available while the transaction is in the `SplitTenderPending` stage with `partialApprovalData.disposition` `Pending`, until `partialApprovalData.dispositionDeadlineUtc`, when the gateway voids it. An API transaction waits for a decision only when its create request set `deferPartialApprovalAcknowledgment`; otherwise its partial approval is accepted when it happens. A transaction that was not partially approved answers 404 `Transactions:PartialApprovalNotFound`. One already decided answers 409 `Transactions:PartialApprovalNotPending`, which includes every partial approval for a merchant that does not accept them, because the gateway voids those at once.

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 POST "{{BASE_URL}}/api/transactions/{id}/partial-approval/split-tender" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/{id}/partial-approval/split-tender' `
    -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.partialApprovalInitiateSplitTender("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/{id}/partial-approval/split-tender', {
  method: 'POST',
  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.PartialApprovalInitiateSplitTenderAsync(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("POST"), "/api/transactions/{id}/partial-approval/split-tender");
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.partial_approval_initiate_split_tender("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/{id}/partial-approval/split-tender",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The partially approved transaction.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.