Skip to main content
POST
Register digital wallet
This endpoint requires the digital-wallets.write scope.

Authorizations

Authorization
string
header
required

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

Body

application/json

Merchant details used to register with a digital wallet provider.

provider
enum<string>
required

The name of the digital wallet provider.

Available options:
apple,
google
Example:

"apple"

merchant_name
string
required

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.

Example:

"Gr4vy"

domain_names
string[]
required

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.

Required array length: 1 - 99 elements
Example:
accept_terms_and_conditions
boolean
required

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.

Example:

true

merchant_url
string<url> | null

The main URL of the merchant.

Example:

"https://example.com"

merchant_display_name
string | null

The consumer facing name of the merchant.

Example:

"Gr4vy"

merchant_country_code
string | null

The country code where the merchant is registered.

Required string length: 2
Example:

"US"

Response

Returns the newly registered digital wallet.

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

type
enum<string>

digital-wallet.

Available options:
digital-wallet
Example:

"digital-wallet"

id
string<uuid>

The ID of the registered digital wallet.

Example:

"8d3fe99b-1422-42e6-bbb3-932d95ae5f79"

merchant_account_id
string

The unique ID for a merchant account.

Example:

"default"

provider
enum<string>

The name of the digital wallet provider.

Available options:
apple,
google
Example:

"apple"

merchant_name
string

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

Example:

"Gr4vy"

merchant_url
string<url> | null

The main URL of the merchant.

Example:

"https://example.com"

merchant_display_name
string | null

The consumer facing name of the merchant.

Example:

"Gr4vy"

merchant_country_code
string | null

The country code where the merchant is registered.

Required string length: 2
Example:

"US"

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.

Required array length: 1 - 99 elements
Example:
fields
Click to Pay · object | null

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

created_at
string<date-time>

The date and time when this digital wallet was registered.

Example:

"2012-12-12T10:53:43+00:00"

updated_at
string<date-time>

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

Example:

"2012-12-12T10:53:43+00:00"

active_certificate_count
integer

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

Example:

1

pending_certificate_count
integer

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

Example:

1

expired_certificate_count
integer

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

Example:

1