Lists every wallet provider this environment supports.
GET
/api/payment-tokenization/wallet-providers/providers
deprecated
Requires: PaymentTokenization.PaymentTokenizations, merchant scope.
Each entry says whether the provider is enabled and what it is able to do, so a checkout page can decide which wallet buttons to show without knowing in advance which wallets exist.
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 |
|---|---|---|---|
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
Body: array of WalletProviderCapabilityOutput
Each item has these fields.
| Field | Type | Description |
|---|---|---|
providerType
required |
all of WalletProviderType | The wallet provider this capability snapshot describes. |
registered
required |
boolean | True when the provider is registered in DI. False would only be returned for future `WalletProviderType` enum values that don't have an implementation yet: the discovery endpoint omits unregistered providers entirely, so callers normally see `Registered = true` on every result. |
enabled
required |
boolean | True when the corresponding `PaymentTokenization.{ProviderType}.Enabled` setting resolves to true. A registered-but-disabled provider should be hidden from production users and shown as opt-in for admins. |
supportsMerchantManagement
required |
boolean | True when the wallet supports server-to-server merchant management (register, get and unregister calls). Apple Pay: true; Google Pay: false. |
supportsPaymentSession
required |
boolean | True when the wallet requires a server-issued payment session before checkout. Apple Pay: true; Google Pay: false. |
supportsDomainAssociation
required |
boolean | True when the wallet expects the merchant domain (or PSP-hosted domain) to serve a provider-issued verification file at a well-known path. Apple Pay: true; Google Pay / Paze: false. |
This response has no documented body fields.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
404 Not Found
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
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. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. 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.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable |
title
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. |
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.