List digital wallets

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.

Response

200 - application/json

A list of registered digital wallets.

items

object[]

A list of registered digital wallets.

items.type

enum<string>

digital-wallet.

Available options:

digital-wallet

items.id

string

The ID of the registered digital wallet.

items.merchant_account_id

string

The unique ID for a merchant account.

items.provider

enum<string>

The name of the digital wallet provider.

Available options:

apple,

google

items.merchant_name

string

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

items.merchant_url

string | null

The main URL of the merchant.

items.merchant_display_name

string | null

The consumer facing name of the merchant.

items.merchant_country_code

string | null

The country code where the merchant is registered.

Required string length: 2

items.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.

items.fields

object

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

items.fields.digital_payment_application_id

string

Unique ID assigned for digital payment application.

items.fields.digital_payment_application_name

string

Name assigned for digital payment application.

items.created_at

string

The date and time when this digital wallet was registered.

items.updated_at

string

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

items.active_certificate_count

integer

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

items.pending_certificate_count

integer

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

items.expired_certificate_count

integer

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

Payments

Instruments

Vault

Connections

Dashboard

Errors

List digital wallets

Authorizations

Response