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
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.
| ||||||||||||||||
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.
|
This model has no documented fields.