Tax: creates or replaces the merchant's binding for one provider.

PUT /api/merchants/{id}/tax-bindings/{providerName} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Requires API key scope: admin (Administration)

Example body for a merchant on its own provider contract: ``` { "isEnabled": true, "credentialSource": "Merchant", "defaultCountryCode": "USA", "fieldValues": [ { "key": "TaxCalculation.ZipTax.ApiKey", "value": "…" }, { "key": "TaxCalculation.ZipTax.ApiVersion", "value": "v60" } ] } ``` For a provider the gateway holds the account for, send `"credentialSource": "Gateway"` and no field values at all: the gateway's own credentials are resolved at lookup time and are never copied onto the merchant. Omitting a secret keeps the value already stored, which is what a caller that read the binding first will naturally send, because reads never return one. Optionally send `If-Match: "<concurrencyStamp>"` for optimistic concurrency (409 on a stale stamp).

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

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "defaultCountryCode": ""
}'

PowerShell

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

$body = @'
{
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "defaultCountryCode": ""
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.merchantTaxBindingUpsertTaxBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", {
  "providerName": "",
  "isEnabled": false,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": false,
      "isConfigured": false
    }
  ],
  "defaultCountryCode": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "providerName": "",
    "isEnabled": false,
    "credentialSource": {},
    "fieldValues": [
      {
        "key": "",
        "value": "",
        "isSecret": false,
        "isConfigured": false
      }
    ],
    "defaultCountryCode": ""
  }),
});

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 MerchantTaxBindingApi(config);
var body = JsonSerializer.Deserialize<MerchantTaxBinding>("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ],
      "defaultCountryCode": ""
    }
    """);

var result = await api.MerchantTaxBindingUpsertTaxBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", 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/{id}/tax-bindings/{providerName}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "providerName": "",
      "isEnabled": false,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": false,
          "isConfigured": false
        }
      ],
      "defaultCountryCode": ""
    }
    """, 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.MerchantTaxBindingApi(client)
    body = winkpg_api.MerchantTaxBinding.from_dict({
      "providerName": "",
      "isEnabled": False,
      "credentialSource": {},
      "fieldValues": [
        {
          "key": "",
          "value": "",
          "isSecret": False,
          "isConfigured": False
        }
      ],
      "defaultCountryCode": ""
    })
    result = api.merchant_tax_binding_upsert_tax_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "providerName": "",
  "isEnabled": False,
  "credentialSource": {},
  "fieldValues": [
    {
      "key": "",
      "value": "",
      "isSecret": False,
      "isConfigured": False
    }
  ],
  "defaultCountryCode": ""
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

The merchant id.

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.

providerName required

path

string

The provider to bind (authoritative; any provider on the body is ignored).

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.

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

providerName required

string

Which tax provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all, so an incompletely boarded row cannot silently become a live selection. Required: When IsEnabled is true. nullablemax length 64

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.

isEnabled required

boolean

Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. 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.

credentialSource required

TaxCredentialSource TaxCredentialSource

Whose provider account the lookups are billed to. Null reads as `Gateway`. 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.

`Gateway`	The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credentialSource reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
`Merchant`	The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.

fieldValues required

array of TaxBindingFieldValue array of TaxBindingFieldValue

The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. <b>Secret values are stored encrypted</b> and are stripped, not decrypted, on every read that leaves the server: the admin UI and the API both see null and re-send a secret only when the operator changes it. Only the server-side call to the provider ever uses the plaintext. Empty for a `Gateway` binding, whose values are filled in at read time from the host-scoped provider settings instead. A gateway-sourced row that carried values would be a copy of the gateway's key living on a merchant document. Conditional: When FieldValues is not null. 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.

Fields of each TaxBindingFieldValue:

Field Type Description

key required

string

The provider setting name this value belongs to, matching a setting field definition the provider's contributor declares. Compared case-insensitively. 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.

value required

string

The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. 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.

isSecret required

boolean

Whether `value` is credential material, and so held encrypted and stripped on read. 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.

isConfigured required

boolean

Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. 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.

defaultCountryCode required

string

The country code to use for a lookup that does not name one. Null falls back to the gateway-wide `TaxCalculation.DefaultCountryCode` setting. 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.

This request body has no documented fields.

Responses

200 OK

Body: MerchantTaxBinding MerchantTaxBinding Each item has these fields.

Field Type Description

providerName required

string

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.

isEnabled required

boolean

Master enable flag for this provider on this merchant. When `false` or null, the selector must not return this binding even though the row exists. 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.

credentialSource required

TaxCredentialSource TaxCredentialSource

Whose provider account the lookups are billed to. Null reads as `Gateway`. 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.

`Gateway`	The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credentialSource reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
`Merchant`	The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.

fieldValues required

array of TaxBindingFieldValue array of TaxBindingFieldValue

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 each TaxBindingFieldValue:

Field Type Description

key required

string

The provider setting name this value belongs to, matching a setting field definition the provider's contributor declares. Compared case-insensitively. 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.

value required

string

The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. 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.

isSecret required

boolean

Whether `value` is credential material, and so held encrypted and stripped on read. 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.

isConfigured required

boolean

Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. 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.

defaultCountryCode required

string

The country code to use for a lookup that does not name one. Null falls back to the gateway-wide `TaxCalculation.DefaultCountryCode` setting. 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.

This response has no documented body fields.

403 Forbidden

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.

401 Unauthorized

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.

400 Bad Request

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.

404 Not Found

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.

501 Not Implemented

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.

500 Internal Server Error

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.

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.

This response has no documented body fields.

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.

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.

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

The API reference isn't available right now

No such operation

This reference may be out of date

Tax: creates or replaces the merchant's binding for one provider.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication