# POST /api/tokens/{id}/redact Erases the stored card or bank account details behind a token. The token record itself is kept, so this is how to honour a deletion request when the record still has to exist. Deactivate only blocks future use and leaves the details stored; delete is refused while any transaction references the token. Redaction is the third answer: the card number, the cardholder name, the bank account and routing numbers, the MICR values, the writer's identification details and any stored processor or network token are erased, while the last four, the card brand, the expiry, the customer and merchant, and the record's own history are kept, so transactions taken on the token still read back the card they were taken on. This cannot be undone. A redacted token can no longer be charged, reactivated or regenerated: a charge against it is refused exactly as one against a deactivated token is, and reactivate and regenerate answer with a coded conflict. Redacting an already redacted token changes nothing and returns the same state, so a retry is safe. **Operation ID:** `tokensRedact` ## Authorization No permission required. Requires API key scope: `tokens` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | The token to redact. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: [`RedactPaymentTokenInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RedactPaymentTokenInput.md) Properties: - `reason` (string) required: Why the stored details are being erased, for example the account deletion request this fulfils. Required, and recorded on the token and in the audit trail. It is stored in the clear, so do not put card, bank account or other sensitive values in it. (nullable) _Example: Erase a stored card on a deletion request_ Permanently erases the account data stored behind the token: the card or account number is cut to its last four digits and the name on it is removed. The token record is kept, now Redacted and inactive, for audit. Put the token's id in the route. The reason is required (5 to 500 characters), is recorded on the token as redactionReason and in the audit trail, and is stored as written, so it must not contain a card number. Redacting a token that is already redacted returns it unchanged. ```json { "reason": "Cardholder asked for their stored card to be deleted" } ``` **Content type:** `text/json` Schema: [`RedactPaymentTokenInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RedactPaymentTokenInput.md) Properties: - `reason` (string) required: Why the stored details are being erased, for example the account deletion request this fulfils. Required, and recorded on the token and in the audit trail. It is stored in the clear, so do not put card, bank account or other sensitive values in it. (nullable) _Example: Erase a stored card on a deletion request_ Permanently erases the account data stored behind the token: the card or account number is cut to its last four digits and the name on it is removed. The token record is kept, now Redacted and inactive, for audit. Put the token's id in the route. The reason is required (5 to 500 characters), is recorded on the token as redactionReason and in the audit trail, and is stored as written, so it must not contain a card number. Redacting a token that is already redacted returns it unchanged. ```json { "reason": "Cardholder asked for their stored card to be deleted" } ``` **Content type:** `application/*+json` Schema: [`RedactPaymentTokenInput`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RedactPaymentTokenInput.md) Properties: - `reason` (string) required: Why the stored details are being erased, for example the account deletion request this fulfils. Required, and recorded on the token and in the audit trail. It is stored in the clear, so do not put card, bank account or other sensitive values in it. (nullable) _Example: Erase a stored card on a deletion request_ Permanently erases the account data stored behind the token: the card or account number is cut to its last four digits and the name on it is removed. The token record is kept, now Redacted and inactive, for audit. Put the token's id in the route. The reason is required (5 to 500 characters), is recorded on the token as redactionReason and in the audit trail, and is stored as written, so it must not contain a card number. Redacting a token that is already redacted returns it unchanged. ```json { "reason": "Cardholder asked for their stored card to be deleted" } ``` ## Responses ### 200 OK **Content type:** `application/json` Schema: [`PaymentTokenDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/PaymentTokenDto.md) Properties: - `extraProperties` (object): (nullable, read only) - `id` (string(uuid)) - `creationTime` (string(date-time)): The date and time when this entity was created. - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable) - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable) - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable) - `isDeleted` (boolean): Indicates whether this entity has been deleted. - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable) - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable) - `tenantId` (string(uuid)): Id of the related tenant. (nullable, read only) - `concurrencyStamp` (string): (nullable) - `numericToken` (integer(int64)): The numeric representation of the token. (nullable) - `cardFormatToken` (string): The card format representation of the token. (nullable) - `transactionId` (string(uuid)): The unique identifier of the associated transaction when the token was created. (nullable) - `paymentDetails` ([PaymentDetailSnapshot](https://devportal.signapay-sbx.winkpg.io/docs/api/models/PaymentDetailSnapshot.md)): The payment details snapshot associated with this token. Fields: - `cardData` ([CardData](https://devportal.signapay-sbx.winkpg.io/docs/api/models/CardData.md)): Conditional: When CardData is not null. - `checkData` ([CheckData](https://devportal.signapay-sbx.winkpg.io/docs/api/models/CheckData.md)): Conditional: When CheckData is not null. - `tokenData` ([TokenData](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenData.md)): Conditional: When TokenData is not null. - `processorTokens` (array<[StoredProcessorToken](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredProcessorToken.md)>): Processor-issued reusable tokens (e.g. TSYS `RequestToken`) captured at auth time and stored alongside the card. Keyed by processor + processor profile; a repeat sale prefers a matching token at the rail and falls back to the PAN. An empty list when no processor token is held. (nullable) - `networkToken` ([StoredNetworkToken](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredNetworkToken.md)): The network token (DPAN) provisioned for this payment method, when one exists. On a read it carries only non-sensitive metadata: state, network, token suffix, expiry and timestamps. The token number and the provider identifiers are never returned. - `paymentMethodType` ([TokenPaymentMethodType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenPaymentMethodType.md)): (read only) Values: - `Unknown`: Not classified. - `Card`: A card, keyed or read. - `Check`: A bank account debited over ACH, or a check. - `DigitalWallet`: A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks. - `AlternativePayment`: An alternative payment method approved inside a provider and presented as an approval reference. - `type` ([TokenType](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenType.md)): The underlying payment type of the token. Values: - `Card`: A card, keyed or read. - `Check`: A bank account debited over ACH, or a check. - `Cash`: Cash, which carries no instrument block of its own. - `DigitalWallet`: A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks. - `AlternativePayment`: An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference. - `category` ([TokenCategory](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenCategory.md)): The category of the token (e.g., internal, network). Values: - `Internal` - `Network` - `Wallet` - `merchantId` (string(uuid)): Id of the related Merchant. (nullable) - `customerId` (string(uuid)): The customer this stored credential is bound to, or `null` when it is not bound to one. (nullable) - `tokenSharing` (boolean): The sharing status of the token. - `label` (string): Optional human-readable label for the token. (nullable) - `status` ([TokenStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenStatus.md)): The status of the token (Active, Inactive, Invalidated). Values: - `Active`: Token is active and can be used for transactions. - `Inactive`: Token is inactive but can be reactivated. - `Invalidated`: Token has been invalidated and replaced by a new token. Cannot be used for new transactions and cannot be reactivated. - `Redacted`: The vaulted account data has been wiped at the owner's request, leaving an audit shell: the last four, brand, BIN metadata, expiry, customer, merchant and lifecycle history survive, and the card number, cardholder name, bank account / routing / MICR values and any stored processor or network token do not. - `invalidatedByTokenId` (string(uuid)): The ID of the token that replaced this one (if invalidated and regenerated). (nullable) - `replacesTokenId` (string(uuid)): The ID of the token that this token replaced (if this is a regenerated token). (nullable) - `regenerationReason` ([TokenRegenerationReason](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TokenRegenerationReason.md)): The reason for token regeneration (if applicable). (nullable) Values: - `Manual`: Manually initiated by user. - `NearExpiration`: Automated regeneration due to near expiration. - `SuspectedCompromise`: Suspected compromise or security concern. - `Other`: Other reason. - `lastRegeneratedAt` (string(date-time)): The timestamp when this token was last regenerated. (nullable) - `redactedAt` (string(date-time)): When the token's stored card or bank account details were erased, or `null` for a token that has not been redacted. (nullable) - `redactionReason` (string): The reason recorded when the token's stored details were erased, or `null` for a token that has not been redacted. (nullable) - `publicReference` (string): The stable, opaque `pt_`-prefixed handle for this token: the only token identifier permitted to leave the gateway, and the value to charge against on a merchant-initiated transaction. Distinct from the internal id, which correlates to a card number and is never treated as a merchant-facing handle. (nullable) ### 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`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": null, "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 401 Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 403 Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 404 Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": null, "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": null, "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": null } } ``` ### 500 Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 501 Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": null, "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": null } } ``` ### Errors These statuses answer with the error envelope outlined below. - `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. - `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. - `403`: Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. - `404`: Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. - `500`: Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. - `501`: Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. - `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. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) Fields: - `code` (string): (nullable) - `message` (string): (nullable) - `details` (string): (nullable) - `data` (object): (nullable) - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": null, "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ## Authentication - `ApiKey` ## 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 RedactPaymentTokenInput. See the Request body section below for its fields. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/tokens/{id}/redact" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "reason": "Cardholder asked for their stored card to be deleted" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "reason": "Cardholder asked for their stored card to be deleted" } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/tokens/{id}/redact' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, TokensApi } from '@winkpg/winkpg-api'; const api = new TokensApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.tokensRedact("3fa85f64-5717-4562-b3fc-2c963f66afa6", { "reason": "Cardholder asked for their stored card to be deleted" }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/tokens/{id}/redact', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "reason": "Cardholder asked for their stored card to be deleted" }), }); 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 TokensApi(config); var body = JsonSerializer.Deserialize(""" { "reason": "Cardholder asked for their stored card to be deleted" } """); var result = await api.TokensRedactAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/tokens/{id}/redact"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "reason": "Cardholder asked for their stored card to be deleted" } """, 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.TokensApi(client) body = winkpg_api.RedactPaymentTokenInput.from_dict({ "reason": "Cardholder asked for their stored card to be deleted" }) result = api.tokens_redact("3fa85f64-5717-4562-b3fc-2c963f66afa6", body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "reason": "Cardholder asked for their stored card to be deleted" } response = requests.request( "POST", "{{BASE_URL}}/api/tokens/{id}/redact", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.