Register digital wallet
Register with a digital wallet provider.
This endpoint requires the digital-wallets.write
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Merchant details used to register with a digital wallet provider.
The name of the digital wallet provider.
apple
, google
The name of the merchant. This is used to register the merchant with a digital wallet provider and this name is not displayed to the buyer.
The main URL of the merchant.
The consumer facing name of the merchant.
The country code where the merchant is registered.
The list of domain names that a digital wallet can be used on. To use a digital wallet on a website, the domain of the site is required to be in this list.
The explicit acceptance of the digital wallet provider's terms and
conditions by the merchant. Needs to be true
to register a new digital
wallet.
Response
A digital wallet (e.g. Apple Pay) that has been registered.
digital-wallet
.
digital-wallet
The ID of the registered digital wallet.
The unique ID for a merchant account.
The name of the digital wallet provider.
apple
, google
The name of the merchant the digital wallet is registered to.
The main URL of the merchant.
The consumer facing name of the merchant.
The country code where the merchant is registered.
The list of domain names that a digital wallet can be used on. To use a digital wallet on a website, the domain of the site is required to be in this list.
Custom attributes for some digital wallets. Currently only used by Click to Pay.
The date and time when this digital wallet was registered.
The date and time when this digital wallet was last updated.
The number of active custom certificates registered for this digital wallet (Apple Pay only).
The number of pending custom certificates registered for this digital wallet (Apple Pay only).
The number of expired custom certificates registered for this digital wallet (Apple Pay only).
Was this page helpful?