Issues a replacement token that supersedes an existing one.

POST /api/tokens/regenerate-async deprecated

No permission required.

Use it to rotate a token, or when its token string may have been exposed. The original token is deactivated and the replacement carries the same stored card or check details under a new identifier. The result returns both, so stored references can be updated.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/tokens/regenerate-async" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newLabel": "",
  "reason": {},
  "notes": ""
}'

PowerShell

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

$body = @'
{
  "newLabel": "",
  "reason": {},
  "notes": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/tokens/regenerate-async' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.tokensRegenerate({
  "newLabel": "",
  "reason": {},
  "notes": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/tokens/regenerate-async', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "newLabel": "",
    "reason": {},
    "notes": ""
  }),
});

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 TokensApi(config);
var body = JsonSerializer.Deserialize<TokenRegenerationInput>("""
    {
      "newLabel": "",
      "reason": {},
      "notes": ""
    }
    """);

var result = await api.TokensRegenerateAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/tokens/regenerate-async");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "newLabel": "",
      "reason": {},
      "notes": ""
    }
    """, 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.TokensApi(client)
    body = winkpg_api.TokenRegenerationInput.from_dict({
      "newLabel": "",
      "reason": {},
      "notes": ""
    })
    result = api.tokens_regenerate(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "newLabel": "",
  "reason": {},
  "notes": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/tokens/regenerate-async",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`tokenId` required	query	string (uuid)	The token to replace.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`newLabel` required	string	Optional new label/nickname for the regenerated token. nullable
`reason` required	all of TokenRegenerationReason	Reason for regenerating the token.
`notes` required	string	Optional notes or context about why the token is being regenerated. nullable

This request body has no documented fields.