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

API reference Models

WalletCheckoutSnapshot

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

Storefront-safe projection of a `WalletProviderRegistration` row, keyed by `(providerType, merchantId)`. Returned by the anonymous checkout snapshot endpoint so the FE can decide whether to render the wallet button and what to pass to the matching session-creation endpoint. Intentionally omits admin-only fields (Id, ConcurrencyStamp, EntityVersion, TenantId, MerchantId, certificate snapshots, audit fields, the full ProviderMetadata map): this DTO is reached without authentication and must not leak operational state.

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
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 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.