Soft-deletes a stored payment method from a customer.

POST /api/customers/delete-stored-payment-method-async deprecated

Requires: Customers.Customers, Customers.Customers.Delete, merchant scope.

If the matched SPM record carries a `PaymentTokenId`, the bound payment token is revoked server-side AFTER the SPM delete has been persisted. The two effects are ordered: the stored payment method is persisted as deleted first, and the bound payment token is revoked only after that succeeds. A list of the customer's payment methods taken immediately afterwards therefore never shows the deleted one, whether or not the revocation has finished.

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 POST "{{BASE_URL}}/api/customers/delete-stored-payment-method-async" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/customers/delete-stored-payment-method-async' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.customersDeleteStoredPaymentMethod();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/customers/delete-stored-payment-method-async', {
  method: 'POST',
  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 CustomersApi(config);
var result = await api.CustomersDeleteStoredPaymentMethodAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/customers/delete-stored-payment-method-async");
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.CustomersApi(client)
    result = api.customers_delete_stored_payment_method()

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/customers/delete-stored-payment-method-async",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`storedPaymentMethodId` required	query	string (uuid)	The identifier of the stored payment method to delete.
`customerId` required	query	string (uuid)	The identifier of the customer who owns the payment method.
`paymentTokenId` required	query	string (uuid)	Ignored. Retained so that existing callers keep compiling. The token to revoke is resolved from the matched stored payment method itself, which is the authoritative binding between the customer, the merchant, the payment method and the token.
`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.