WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.

API reference Models

CreateStandaloneTokenResponseDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
id required string (uuid) The internal vault record id of the minted token. Deprecated for external use: charge with `publicReference` instead.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
numericToken required integer (int64) Legacy numeric form of the token, retained for existing internal callers and back-compat. Not the preferred external handle: use `publicReference`. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
cardFormatToken required 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
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
publicReference required string The chargeable public reference of the minted token (the opaque `pt_`-prefixed handle). nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maskedPaymentDetails required PaymentDetailSnapshot PaymentDetailSnapshot
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of PaymentDetailSnapshot:

Field Type Description
cardData required CardData CardData Conditional: When CardData is not null.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
checkData required CheckData CheckData Conditional: When CheckData is not null.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
tokenData required TokenData TokenData Conditional: When TokenData is not null.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
processorTokens required array of StoredProcessorToken array of StoredProcessorToken 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
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
networkToken required StoredNetworkToken StoredNetworkToken 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.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
paymentMethodType required TokenPaymentMethodType TokenPaymentMethodType read only
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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.

This body has no documented fields.

type required TokenType TokenType 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: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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 required TokenCategory TokenCategory Defines the category of a token used in transaction processing.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Internal
Network
Wallet
idempotencyStatus required StandaloneTokenCreateIdempotencyStatus StandaloneTokenCreateIdempotencyStatus What create idempotency did to the request that produced this response.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
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.
storedCredentialConsentId required string (uuid) The id of the stored-credential consent recorded by a token create whose request carried one (a standalone create or a mint from a transaction); null otherwise. A later merchant-initiated charge on the token resolves the consent automatically, so sending this id as `storedCredentialConsentId` is optional. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
consentedCardPrice required ConsentedCardPriceDto ConsentedCardPriceDto The dual pricing card price the stored-credential consent recorded, as the platform priced it from the merchant's configuration. Read-only: never taken from the request. Null when the request carried no consent, or when the consent recorded no card price.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of ConsentedCardPriceDto:

Field Type Description
rate required number (double) The card price rate the consent recorded, as a decimal fraction of each payment's cash price (`0.04` is 4 percent). Read-only and priced by the platform. Null when the consent recorded an amount instead. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
amount required number (double) The flat card price uplift the consent recorded for each payment, in the merchant's currency (the unit of the enrollment terms' `fixedAmount`). Read-only and priced by the platform. Null when the consent recorded a rate instead. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.