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

MerchantNetworkTokenBinding

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

Per-merchant network token provider binding. Persisted as an element of `Merchant.NetworkTokenBindings`.

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
providerName required string Which network token provider this entry binds the merchant to, by the provider's registered name. Compared case-insensitively. A null or blank provider is treated as no binding at all. nullablemax length 64
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.
isEnabled required boolean Whether this provider is switched on for this merchant. When `false` or null, the selector does not return this binding even though the row exists. 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.
credentialSource required ProviderCredentialSource ProviderCredentialSource Whose provider account the merchant's tokens live in. Null reads as `Gateway`. 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.
Gateway The gateway's own provider account. The binding stores no credential of its own: the values are filled in at read time from the host-scoped provider settings, and the merchant surfaces never carry them. This is what a null credential source reads as, which is the safe default: a half-completed row cannot accidentally claim to hold the merchant's own contract.
Merchant The merchant's own provider account. The binding carries the credentials, with every secret value held as ciphertext and stripped on any read that leaves the server.
fieldValues required array of NetworkTokenBindingFieldValue array of NetworkTokenBindingFieldValue The provider-declared configuration values for this merchant, keyed by the setting names the provider declares. Conditional: When FieldValues is not null. 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.

Fields of each NetworkTokenBindingFieldValue:

Field Type Description
key required string The provider setting name this value belongs to, matching a setting field definition the provider's contributor declares. Compared case-insensitively. 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.
value required string The configured value. Ciphertext at rest whenever `isSecret` is `true`, and `null` on every read that leaves the server. 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.
isSecret required boolean Whether `value` is credential material, and so held encrypted and stripped on read. 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.
isConfigured required boolean Whether a secret value is stored, set on reads so an operator can tell a configured secret from an empty one without the value ever being sent. 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.

providerAccountId required string The provider's account or organization id for this merchant, when the provider keys tokens by one. Not a secret. nullablemax length 128
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.
usageMode required NetworkTokenUsageMode NetworkTokenUsageMode How far the merchant uses network tokens. Null reads as `ProvisionOnly`. 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.
ProvisionOnly Provision and maintain network tokens for the merchant's stored cards, but keep charging the card number.
ProvisionAndCharge Provision network tokens and charge them in place of the card number where a processor supports it.
enabledNetworks required array of string array of The card networks to provision tokens for, by the names in `NetworkTokenNetworks`. Null reads as Visa and Mastercard. 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 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.