POST

/digital-wallets

curl --request POST \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/digital-wallets \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accept_terms_and_conditions": true,
  "domain_names": [
    "example.com"
  ],
  "merchant_name": "Gr4vy",
  "provider": "apple"
}'
{
  "active_certificate_count": "1",
  "created_at": "2012-12-12T10:53:43+00:00",
  "domain_names": [
    "example.com"
  ],
  "expired_certificate_count": "1",
  "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
  "merchant_account_id": "default",
  "merchant_name": "Gr4vy",
  "merchant_url": "https://example.com",
  "pending_certificate_count": "1",
  "provider": "apple",
  "type": "digital-wallet",
  "updated_at": "2012-12-12T10:53:43+00:00"
}

This endpoint requires the digital-wallets.write scope.

Authorizations

Authorizationheaderrequired
string

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

Body

application/json
accept_terms_and_conditionsrequired
boolean

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.

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

merchant_namerequired
string

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.

merchant_url
string | null

The main URL of the merchant. This is used to register the merchant with a digital wallet provider and this URL is not displayed to the buyer.

providerrequired
enum<string>

The name of the digital wallet provider.

Available options:
apple,
google

Response

201 - application/json
active_certificate_count
integer

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

created_at
string

The date and time when this digital wallet was registered.

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.

expired_certificate_count
integer

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

id
string

The ID of the registered digital wallet.

merchant_account_id
string

The unique ID for a merchant account.

merchant_name
string

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

merchant_url
string | null

The main URL of the merchant.

pending_certificate_count
integer

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

provider
enum<string>

The name of the digital wallet provider.

Available options:
apple,
google
type
enum<string>

digital-wallet.

Available options:
digital-wallet
updated_at
string

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