MerchantDigitalWallet
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-merchant digital wallet record (Apple Pay, Google Pay, …). Persisted as an element of `Merchant.DigitalWallets`. The aggregate keeps at most one entry per `walletProviderType`; collection membership decides whether the merchant participates in that wallet at all, and `isEnabled` decides whether the merchant currently has it switched on. `paymentTokenizationRegistrationId` points at a row in the PaymentTokenization module's `WalletProviderRegistration` aggregate. It may reference either a platform-level row (merchant inherits the platform's Apple Merchant ID + domain set) or a merchant-level row (this merchant brought its own Apple Merchant ID).
Values
Fields
| Field | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
walletProviderType
required |
WalletProviderType WalletProviderType | Which wallet this entry describes (Apple Pay, Google Pay, …).
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.
| ||||||||||
isEnabled
required |
boolean | Master enable flag for this wallet on this merchant. When `false` or
null, the merchant's checkout surfaces must skip this wallet even if a
registration row exists. Toggle is operator-controlled on the Merchant Edit
page and persists with the Merchant save.
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.
| ||||||||||
paymentTokenizationRegistrationId
required |
string (uuid) | FK to the PaymentTokenization aggregate row this merchant uses. May point at
a platform-level row (inheriting) or a merchant-level row (own integrator).
Nullable so a merchant can be marked enabled before the operator picks /
registers a specific row, and so a deleted registration leaves an
inspectable "dangling but disabled" state rather than a hard reference.
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.