Payment encryption: unbinds one provider.

DELETE /api/merchants/{id}/payment-encryption-bindings/{providerName} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Removes the binding along with any stored credentials and its whole key serial identifier table. To retire one key rather than the whole binding, deactivate that key entry instead. Optionally send `If-Match: "<concurrencyStamp>"` for optimistic concurrency (409 on a stale stamp). Returns 404 when the merchant has no binding for that provider.

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 DELETE "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method DELETE -Uri '{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.merchantPaymentEncryptionBindingDeletePaymentEncryptionBinding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}', {
  method: 'DELETE',
  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 MerchantPaymentEncryptionBindingApi(config);
var result = await api.MerchantPaymentEncryptionBindingDeletePaymentEncryptionBindingAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PROVIDER_NAME");

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "/api/merchants/{id}/payment-encryption-bindings/{providerName}");
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.MerchantPaymentEncryptionBindingApi(client)
    result = api.merchant_payment_encryption_binding_delete_payment_encryption_binding("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PROVIDER_NAME")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "DELETE",
    "{{BASE_URL}}/api/merchants/{id}/payment-encryption-bindings/{providerName}",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The merchant id.
`providerName` required	path	string	The provider to unbind.
`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.

Responses

204 No content. The operation succeeded and returns no body.

Body: Each item has these fields.

Field	Type	Description

This response has no body.