# POST /api/merchants/{id}/tax-bindings/{providerName}/test-connection Tax: probes the merchant's bound provider and reports whether it answered. The probe never touches a payment path: it calls the provider's tax-code endpoint, which is credential-scoped and takes no inputs. It carries back no vendor response body and no credential material. A candidate body is used for the probe and nothing else: it is never persisted, never logged, and never echoed in the response. **Operation ID:** `merchantTaxBindingTestTaxBindingConnection` ## Authorization Requires: Merchants.Merchants.Update, merchant scope. Required permissions: - `Merchants.Merchants.Update` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | The merchant id. | | providerName | path | yes | string | The provider to probe. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body Optional candidate credentials to probe instead of the stored ones, so a boarding can be tested before it is saved. Omit the body to probe the binding as stored. **Content type:** `application/json` Schema: `MerchantTaxBinding` Properties: - `providerName` (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. - `isEnabled` (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. - `credentialSource` (object): Whose provider account the lookups are billed to. Null reads as `Gateway`. - `fieldValues` (array): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted 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. - `defaultCountryCode` (string): The country code to use for a lookup that does not name one. Null falls back to the gateway-wide `TaxCalculation.DefaultCountryCode` setting. **Content type:** `text/json` Schema: `MerchantTaxBinding` Properties: - `providerName` (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. - `isEnabled` (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. - `credentialSource` (object): Whose provider account the lookups are billed to. Null reads as `Gateway`. - `fieldValues` (array): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted 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. - `defaultCountryCode` (string): The country code to use for a lookup that does not name one. Null falls back to the gateway-wide `TaxCalculation.DefaultCountryCode` setting. **Content type:** `application/*+json` Schema: `MerchantTaxBinding` Properties: - `providerName` (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. - `isEnabled` (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. - `credentialSource` (object): Whose provider account the lookups are billed to. Null reads as `Gateway`. - `fieldValues` (array): The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Secret values are stored encrypted 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. - `defaultCountryCode` (string): The country code to use for a lookup that does not name one. Null falls back to the gateway-wide `TaxCalculation.DefaultCountryCode` setting. ## Responses ### 200 OK **Content type:** `application/json` Schema: `TaxBindingConnectionTestResultDto` Properties: - `succeeded` (boolean): Gets or sets whether the provider answered the probe. - `reason` (string): Gets or sets a short explanation of the outcome, safe to show an operator. - `steps` (array): Gets or sets the steps the test ran, in order. The platform always sends a list, empty when the test ran nothing; the published schema still marks it nullable, as it does every array, so a generated client should guard as it would any other. `succeeded` and `reason` are not derived from this list and keep their meaning for a caller that reads only them. ### 403 Forbidden **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 401 Unauthorized **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 400 Bad Request **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 404 Not Found **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 501 Not Implemented **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 500 Internal Server Error **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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. See the error-code reference in this document's description for the values `error.code` can take. **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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` 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. - `title` (string) required: A short, human-readable summary of the problem type. - `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. - `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` Properties: - `error` (RemoteServiceErrorInfo) ## 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 ```bash curl -X POST "{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}/test-connection" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "providerName": "", "isEnabled": false, "credentialSource": {}, "fieldValues": [ { "key": "", "value": "", "isSecret": false, "isConfigured": false } ], "defaultCountryCode": "" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "providerName": "", "isEnabled": false, "credentialSource": {}, "fieldValues": [ { "key": "", "value": "", "isSecret": false, "isConfigured": false } ], "defaultCountryCode": "" } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}/test-connection' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, MerchantTaxBindingApi } from '@winkpg/winkpg-api'; const api = new MerchantTaxBindingApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.merchantTaxBindingTestTaxBindingConnection("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", { "providerName": "", "isEnabled": false, "credentialSource": {}, "fieldValues": [ { "key": "", "value": "", "isSecret": false, "isConfigured": false } ], "defaultCountryCode": "" }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}/test-connection', { method: 'POST', 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(); ``` ### 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 MerchantTaxBindingApi(config); var body = JsonSerializer.Deserialize(""" { "providerName": "", "isEnabled": false, "credentialSource": {}, "fieldValues": [ { "key": "", "value": "", "isSecret": false, "isConfigured": false } ], "defaultCountryCode": "" } """); var result = await api.MerchantTaxBindingTestTaxBindingConnectionAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME", 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/merchants/{id}/tax-bindings/{providerName}/test-connection"); 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(); ``` ### 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.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_test_tax_binding_connection("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME", body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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( "POST", "{{BASE_URL}}/api/merchants/{id}/tax-bindings/{providerName}/test-connection", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.