# POST /api/tokens/create-from-transaction-async Creates a reusable token from the payment method a previous transaction stored. This is the tokenize-after-the-fact path, for a card or check already charged. The transaction is read within `merchantId` only: one belonging to another merchant is reported as not found. The resulting token charges like any other, so supply its public reference as `TokenData.Token`. No card number or full account number crosses the wire in either direction: the request carries only identifiers, and the response carries the token handles plus masked and last-four values. A transaction that stored no reusable payment method is refused with a coded business error. `customerId` is accepted so callers can pass the customer they intend to attach the token to, but it is not stored on the token itself. **Operation ID:** `tokensCreateFromTransaction` ## Authorization No permission required. Requires API key scope: `tokens` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | transactionId | query | no | string(uuid) | The prior transaction to mint the token from. | | merchantId | query | no | string(uuid) | The owning merchant. Must be within the caller's scope, and the transaction must belong to it. | | customerId | query | no | string(uuid) | Optional customer the caller intends to attach the token to. Not stored on the token. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`CreateStandaloneTokenResponseDto`](https://devportal.demo.winkpg.io/docs/api/models/CreateStandaloneTokenResponseDto.md) Properties: - `id` (string(uuid)): The internal vault record id of the minted token. Deprecated for external use: charge with `publicReference` instead. - `numericToken` (integer(int64)): Legacy numeric form of the token, retained for existing internal callers and back-compat. Not the preferred external handle: use `publicReference`. (nullable) - `cardFormatToken` (string): Legacy card-format (PAN-shaped) form of the token, retained for existing internal callers and back-compat. Not the preferred external handle: use `publicReference`. (nullable) - `publicReference` (string): The chargeable public reference of the minted token (the opaque `pt_`-prefixed handle). (nullable) - `maskedPaymentDetails` ([PaymentDetailSnapshot](https://devportal.demo.winkpg.io/docs/api/models/PaymentDetailSnapshot.md)) Fields: - `cardData` ([CardData](https://devportal.demo.winkpg.io/docs/api/models/CardData.md)): Conditional: When CardData is not null. - `checkData` ([CheckData](https://devportal.demo.winkpg.io/docs/api/models/CheckData.md)): Conditional: When CheckData is not null. - `tokenData` ([TokenData](https://devportal.demo.winkpg.io/docs/api/models/TokenData.md)): Conditional: When TokenData is not null. - `processorTokens` (array<[StoredProcessorToken](https://devportal.demo.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.demo.winkpg.io/docs/api/models/StoredNetworkToken.md)): A stored network token (DPAN) for this payment method. Not populated: network-token acquisition is not yet supported, so this is always absent. - `paymentMethodType` ([TokenPaymentMethodType](https://devportal.demo.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.demo.winkpg.io/docs/api/models/TokenType.md)): Defines the supported token types used in transaction-related models. Also aliased as the platform's payment-method category (`InitializeContext` imports it as `PaymentMethodCategory`), which is what the processor-profile pre-filter narrows on. 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.demo.winkpg.io/docs/api/models/TokenCategory.md)): Defines the category of a token used in transaction processing. Values: - `Internal` - `Network` - `Wallet` - `idempotencyStatus` ([StandaloneTokenCreateIdempotencyStatus](https://devportal.demo.winkpg.io/docs/api/models/StandaloneTokenCreateIdempotencyStatus.md)): What create idempotency did to the request that produced this response. Values: - `NotRequested`: The request carried no idempotencyKey, so there was nothing to deduplicate. A repeat send mints a second token for the same card. - `KeyAccepted`: The request carried an idempotencyKey and this request claimed it. This is the original create; a repeat send of the same request inside the deduplication window returns this token instead of minting another. - `Replayed`: The idempotencyKey matched a create that had already produced a token for this merchant and credential, so nothing was minted. The response body is that original token exactly as it stands, with its original identifiers and public reference. ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.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" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.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" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.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.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.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" } } ``` ### 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.demo.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.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/tokens/create-from-transaction-async" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/tokens/create-from-transaction-async' ` -Headers $headers ``` ### 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.tokensCreateFromTransaction(); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/tokens/create-from-transaction-async', { method: 'POST', headers: { "api-key": "{{API_KEY}}", }, }); 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; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new TokensApi(config); var result = await api.TokensCreateFromTransactionAsync(); ``` ### C# (raw HTTP) ```csharp using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/tokens/create-from-transaction-async"); request.Headers.Add("api-key", "{{API_KEY}}"); 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) result = api.tokens_create_from_transaction() ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "POST", "{{BASE_URL}}/api/tokens/create-from-transaction-async", headers=headers, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.