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 operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

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-10-22 22:09 UTC.

API reference Wallets

Checkout Snapshot: returns the storefront-safe snapshot for the (provider, merchant) pair.

GET /api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId} deprecated

No permission required.

When the wallet is not available for the merchant, the response reports `isEnabled: false` rather than an error. Treat that as "do not render the button".

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

Code sample language

cURL

curl -X GET "{{BASE_URL}}/api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId}" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId}' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.walletCheckoutSnapshotGetSnapshot("PROVIDER_TYPE", "3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId}', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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 WalletsApi(config);
var result = await api.WalletCheckoutSnapshotGetSnapshotAsync("PROVIDER_TYPE", Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId}");
request.Headers.Add("api-key", "{{API_KEY}}");

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.WalletsApi(client)
    result = api.wallet_checkout_snapshot_get_snapshot("PROVIDER_TYPE", "3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/payment-tokenization/checkout-snapshot/{providerType}/{merchantId}",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
providerType required path WalletProviderType WalletProviderType Defines the supported wallet provider types used for payment tokenization.
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 Unknown wallet provider.
ApplePay Apple Pay wallet provider.
GooglePay Google Pay wallet provider.
NetworkToken Network tokenization provider (Visa, Mastercard etc).
Paze Paze (Early Warning) wallet provider.
merchantId required path string (uuid)
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.
suppressNulls required query boolean If true, omit properties with null 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.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

200 OK

Body: WalletCheckoutSnapshot WalletCheckoutSnapshot Each item has these fields.

Field Type Description
providerType required WalletProviderType WalletProviderType The wallet provider this snapshot describes. Echoed back so the FE can confirm the response matches the request.
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 Unknown wallet provider.
ApplePay Apple Pay wallet provider.
GooglePay Google Pay wallet provider.
NetworkToken Network tokenization provider (Visa, Mastercard etc).
Paze Paze (Early Warning) wallet provider.
isEnabled required boolean True only when the merchant has an enabled `DigitalWallets[]` binding, the binding points at a resolvable `WalletProviderRegistration` row, AND that row is `Active`. The FE MUST check this flag before rendering the wallet button: a non-null registration alone is not sufficient evidence the merchant is opted in.
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.
merchantDisplayName required string Merchant display name as registered with the provider. Sourced from `MerchantDisplayName`. `null` when no resolvable registration row was found. 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.
merchantUrl required string Canonical merchant URL registered with the provider. Sourced from `MerchantUrl`. `null` when no resolvable registration row was found. 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.
verifiedDomains required array of string array of Domains the wallet provider has verified ownership of (filtered to `Verified` entries). The FE selects the entry matching the current page host and passes it to `CreateWalletPaymentSessionInput.InitiativeContext`. Empty when no resolvable registration row was found. 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.
status required WalletRegistrationStatus WalletRegistrationStatus Lifecycle status of the underlying registration row, so the FE can show "wallet is being set up" copy when `isEnabled` is false due to the row not yet being `Active`. `null` when no resolvable registration row was found. 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.
Pending Registration created but not started.
Registering Registration process in progress.
CertificatesPending Waiting for certificates to be uploaded.
VerifyingDomains Domain verification in progress.
Active Wallet provider fully active.
Suspended Provider temporarily suspended.
Expired Certificates expired.
Failed Registration failed.

This response has no documented body fields.

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 lists the values `error.code` can take. 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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

    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.