GET
/
digital-wallets
/
{digital_wallet_id}

This endpoint requires the digital-wallets.read scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

digital_wallet_id
string
required

The ID of the registered digital wallet.

Response

200 - application/json

A digital wallet (e.g. Apple Pay) that has been registered.

type
enum<string>

digital-wallet.

Available options:
digital-wallet
id
string

The ID of the registered digital wallet.

merchant_account_id
string

The unique ID for a merchant account.

provider
enum<string>

The name of the digital wallet provider.

Available options:
apple,
google
merchant_name
string

The name of the merchant the digital wallet is registered to.

merchant_url
string | null

The main URL of the merchant.

merchant_display_name
string | null

The consumer facing name of the merchant.

merchant_country_code
string | null

The country code where the merchant is registered.

Required string length: 2
domain_names
string[]

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.

fields
object

Custom attributes for some digital wallets. Currently only used by Click to Pay.

created_at
string

The date and time when this digital wallet was registered.

updated_at
string

The date and time when this digital wallet was last updated.

active_certificate_count
integer

The number of active custom certificates registered for this digital wallet (Apple Pay only).

pending_certificate_count
integer

The number of pending custom certificates registered for this digital wallet (Apple Pay only).

expired_certificate_count
integer

The number of expired custom certificates registered for this digital wallet (Apple Pay only).

Was this page helpful?

List digital walletsRegister digital wallet