Processor Profile: removes a processor profile from the merchant.

DELETE /api/merchants/{id}/processor-profiles/{profileId} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

The removal runs the open-batch deactivation guard: a profile with unsettled transactions in an open batch cannot be removed and the request is rejected with a business error. Returns 404 when the merchant or profile does not exist. <b>This DELETE answers with a body where it previously answered with none.</b> The new stamp was reported only in the `ETag` header before, deliberately, so a client that did not read the header saw exactly the response it always had. Returning it is now required: the proxy matches an action against the interface method by name and signature, and the interface's return type is `ProcessorProfileDeletionResultDto`. The header is still written, so nothing that already reads it has to change, and the added member is declared as a breaking change for generated SDKs rather than absorbed silently.

Try this in the console

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}/processor-profiles/{profileId}" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method DELETE -Uri '{{BASE_URL}}/api/merchants/{id}/processor-profiles/{profileId}' `
    -Headers $headers

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.merchantProcessorProfileDeleteProcessorProfile("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/processor-profiles/{profileId}', {
  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 MerchantsApi(config);
var result = await api.MerchantProcessorProfileDeleteProcessorProfileAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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("DELETE"), "/api/merchants/{id}/processor-profiles/{profileId}");
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.MerchantsApi(client)
    result = api.merchant_processor_profile_delete_processor_profile("3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "DELETE",
    "{{BASE_URL}}/api/merchants/{id}/processor-profiles/{profileId}",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The merchant id.
`profileId` required	path	string (uuid)	The processor profile id.
`If-Match` required	header	string	The merchant's concurrency stamp, read from the `If-Match` header. When supplied and stale the write is rejected with 409; when omitted, no concurrency check is performed.
`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.