WalletProviderRegistrationUpdateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
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 | Wallet provider this operation targets.
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.
| ||||||||||||
level
required |
WalletRegistrationLevel WalletRegistrationLevel | Scope of the registration. `Platform`
must be paired with `merchantId` = null;
`Merchant` must be paired with a
non-null `merchantId`. Server-side validation rejects any
other combination.
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 |
string (uuid) | Identifier of the merchant this registration belongs to. Required when
`level` = `Merchant`;
must be null when `level` = `Platform`.
Conditional: When ForbidsMerchantId(Level) is true.
Required: When RequiresMerchantId(Level) is true.
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.
| ||||||||||||
providerMerchantIdentifier
required |
string | Provider-side identifier: the value the wallet provider should use for
this merchant going forward. Free-form when allowed by the provider
(Apple Pay accepts any partner-supplied string).
Required: Conditional (see validator source).
nullablemax length 128
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.
| ||||||||||||
gatewayMerchantId
required |
string | The merchant's identifier <b>at this gateway</b>, required by a provider whose model
round-trips one. Google Pay sends it to the browser as
`tokenizationSpecification.parameters.gatewayMerchantId` and copies it into the
encrypted payment token, so the decrypted message says which merchant the shopper
believed they were paying.
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.
| ||||||||||||
merchantDisplayName
required |
string | Merchant display name surfaced to the wallet provider.
nullablemax length 256
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. Must be an absolute HTTPS URL.
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.
| ||||||||||||
domains
required |
array of string array of | Domains to register. Apple Pay accepts multiple; Paze accepts exactly one (the HPP SDK
initializes with a single profile id, so a Paze registration maps to one domain / one
profile: enforced by the validator). Each domain must already host the
provider-specified verification file before this call is made.
Required: Conditional (see validator source).
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.
| ||||||||||||
isSandbox
required |
boolean | Platform-level gateway environment toggle: `true` = Sandbox, `false` =
Production (default). Honored only when `level` =
`Platform`; merchant-level rows ignore it and
derive the environment from the merchant's `IsTest` flag.
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.
| ||||||||||||
onboarding
required |
WalletMerchantOnboardingInput WalletMerchantOnboardingInput | Richer onboarding details for providers whose registration contract needs them
(see `WalletProviderRegistrationTraits.RequiresOnboardingDetails`: Paze today).
Required for those providers, and ignored for the rest.
Required: Conditional (see validator source).
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 of WalletMerchantOnboardingInput:
This body has no documented fields. | ||||||||||||||
concurrencyStamp
required |
string |
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.