WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.

API reference Merchants

Update order data defaults for the signed-in user's merchant

PUT /api/merchants/self/order-data-defaults deprecated

Requires: Merchants.SelfServiceSettings.Manage, merchant scope.

Requires API key scope: admin (Administration)

Resolves the merchant from the signed-in user's context, which is established at interactive sign-in. A credential that carries no merchant context, such as an API key, receives `400 Merchants:NoCurrentMerchant` even when it holds the required scope and permission. API-key callers write the same values through `PUT /api/merchants/{id}` with `processing.orderDataDefaults` set, which requires the `Merchants.Merchants.Update` permission. The built-in Merchant role does not hold it, so a key owned by a merchant account has no API path to this setting; a reseller-owned or administrator-owned key does.

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

Code sample language

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/self/order-data-defaults" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
}'

PowerShell

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

$body = @'
{
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/self/order-data-defaults' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MerchantsApi } from '@winkpg/winkpg-api';

const api = new MerchantsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantsUpdateOrderDataDefaults({
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/self/order-data-defaults', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "settings": {},
    "concurrencyStamp": "",
    "isFeatureEnabled": false,
    "virtualTerminalFields": {}
  }),
});

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 MerchantsApi(config);
var body = JsonSerializer.Deserialize<OrderDataDefaultSettingsDto>("""
    {
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": false,
      "virtualTerminalFields": {}
    }
    """);

var result = await api.MerchantsUpdateOrderDataDefaultsAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/merchants/self/order-data-defaults");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": false,
      "virtualTerminalFields": {}
    }
    """, 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.MerchantsApi(client)
    body = winkpg_api.OrderDataDefaultSettingsDto.from_dict({
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": False,
      "virtualTerminalFields": {}
    })
    result = api.merchants_update_order_data_defaults(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": False,
  "virtualTerminalFields": {}
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/self/order-data-defaults",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null values.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description
settings required OrderDataDefaultSettings OrderDataDefaultSettings The order data default settings values.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of OrderDataDefaultSettings:

Field Type Description
enable required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToApi required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToApi required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToVt required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToVt required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToHpp required boolean Whether Level 2 defaults apply to Hosted Payment Page transactions. `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every merchant document written before this toggle existed already had: hosted page transactions were bucketed under the API toggle. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToHpp required boolean Whether Level 3 defaults apply to Hosted Payment Page transactions. `null` means "follow `applyLevel3DefaultsToApi`". See `applyLevel2DefaultsToHpp` for why. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultMerchantZip required string Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. nullablemax length 10
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultTaxRate required number (double) Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate. Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultShipFromZip required string Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. nullablemax length 10
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDestinationCountryCode required string Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). nullablemax length 3
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDutyAmount required number (double) Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultFreightAmount required number (double) Default freight/shipping amount for L3 enhanced data. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDiscountAmount required number (double) Default header-level discount amount for L3 enhanced data. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultLineItemValues required LineItemDefaults LineItemDefaults Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultLineItem required Level3LineItem Level3LineItem A template line item that auto-populates as the first line item on new transactions. Useful for single-product merchants (parking, subscriptions, recurring services). When null, no template line item is added.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

concurrencyStamp required string Concurrency stamp for optimistic concurrency control. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isFeatureEnabled required boolean Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant. Read-only: set by the server, ignored on update.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
virtualTerminalFields required VirtualTerminalFields VirtualTerminalFields The merchant's Virtual Terminal field configuration at the time of load. Used by the UI to enforce cross-field constraints (e.g. a default tax rate requires `taxAmount` to be enabled). Read-only: set by the server, ignored on update.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of VirtualTerminalFields:

Field Type Description
customer required VirtualTerminalCustomerField VirtualTerminalCustomerField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
invoiceNumber required VirtualTerminalInvoiceNumField VirtualTerminalInvoiceNumField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
purchaseOrderNumber required VirtualTerminalPurchaseOrderNumField VirtualTerminalPurchaseOrderNumField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billingAddress required VirtualTerminalBillingAddressFieldGroup VirtualTerminalBillingAddressFieldGroup
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shippingAddress required VirtualTerminalShippingAddressFieldGroup VirtualTerminalShippingAddressFieldGroup
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
contactPhone required VirtualTerminalPhoneField VirtualTerminalPhoneField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
level3Amount required VirtualTerminalLevel3AmountField VirtualTerminalLevel3AmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shippingAmount required VirtualTerminalShippingAmountField VirtualTerminalShippingAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
convenienceAmount required VirtualTerminalConvenienceFeeField VirtualTerminalConvenienceFeeField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
dutyAmount required VirtualTerminalDutyAmountField VirtualTerminalDutyAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
tipAmount required VirtualTerminalTipAmountField VirtualTerminalTipAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxAmount required VirtualTerminalTaxField VirtualTerminalTaxField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailAddress required VirtualTerminalEmailField VirtualTerminalEmailField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This request body has no documented fields.

Responses

Response status

OK

Body: OrderDataDefaultSettingsDto OrderDataDefaultSettingsDto Each item has these fields.

Field Type Description
settings required OrderDataDefaultSettings OrderDataDefaultSettings The order data default settings values.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of OrderDataDefaultSettings:

Field Type Description
enable required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToApi required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToApi required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToVt required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToVt required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel2DefaultsToHpp required boolean Whether Level 2 defaults apply to Hosted Payment Page transactions. `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every merchant document written before this toggle existed already had: hosted page transactions were bucketed under the API toggle. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
applyLevel3DefaultsToHpp required boolean Whether Level 3 defaults apply to Hosted Payment Page transactions. `null` means "follow `applyLevel3DefaultsToApi`". See `applyLevel2DefaultsToHpp` for why. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultMerchantZip required string Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. nullablemax length 10
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultTaxRate required number (double) Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate. Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultShipFromZip required string Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. nullablemax length 10
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDestinationCountryCode required string Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). nullablemax length 3
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDutyAmount required number (double) Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultFreightAmount required number (double) Default freight/shipping amount for L3 enhanced data. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultDiscountAmount required number (double) Default header-level discount amount for L3 enhanced data. nullablemin 0
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultLineItemValues required LineItemDefaults LineItemDefaults Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultLineItem required Level3LineItem Level3LineItem A template line item that auto-populates as the first line item on new transactions. Useful for single-product merchants (parking, subscriptions, recurring services). When null, no template line item is added.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

concurrencyStamp required string Concurrency stamp for optimistic concurrency control. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isFeatureEnabled required boolean Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant. Read-only: set by the server, ignored on update.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
virtualTerminalFields required VirtualTerminalFields VirtualTerminalFields The merchant's Virtual Terminal field configuration at the time of load. Used by the UI to enforce cross-field constraints (e.g. a default tax rate requires `taxAmount` to be enabled). Read-only: set by the server, ignored on update.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of VirtualTerminalFields:

Field Type Description
customer required VirtualTerminalCustomerField VirtualTerminalCustomerField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
invoiceNumber required VirtualTerminalInvoiceNumField VirtualTerminalInvoiceNumField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
purchaseOrderNumber required VirtualTerminalPurchaseOrderNumField VirtualTerminalPurchaseOrderNumField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billingAddress required VirtualTerminalBillingAddressFieldGroup VirtualTerminalBillingAddressFieldGroup
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shippingAddress required VirtualTerminalShippingAddressFieldGroup VirtualTerminalShippingAddressFieldGroup
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
contactPhone required VirtualTerminalPhoneField VirtualTerminalPhoneField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
level3Amount required VirtualTerminalLevel3AmountField VirtualTerminalLevel3AmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shippingAmount required VirtualTerminalShippingAmountField VirtualTerminalShippingAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
convenienceAmount required VirtualTerminalConvenienceFeeField VirtualTerminalConvenienceFeeField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
dutyAmount required VirtualTerminalDutyAmountField VirtualTerminalDutyAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
tipAmount required VirtualTerminalTipAmountField VirtualTerminalTipAmountField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxAmount required VirtualTerminalTaxField VirtualTerminalTaxField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailAddress required VirtualTerminalEmailField VirtualTerminalEmailField
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

  1. 400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
  2. 401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
  3. 403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
  4. 404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
  5. 409 Conflict Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.
  6. 500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
  7. 501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
  8. 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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description
code required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
message required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
details required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
data required object nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
validationErrors required array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Merchants

Authentication

  • ApiKey with scopes

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.