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