List digital wallets

Payments

Transactions
Buyers
Checkout Sessions
Payment links
Payment options
Payouts
Refunds
Sessions
Settlement records

Instruments

Card schemes
Card details
Digital wallets
Gift cards
Payment methods
Payment method definitions

Vault

Account updater
Network tokens
Payment service tokens
Vault Forward
Vault Forward endpoints
Vault Forward authentication

Connections

All services
Payment services
Digital wallets
- GET
  List digital wallets
- GET
  Get digital wallet
- POST
  Register digital wallet
- PUT
  Update digital wallet
- DEL
  De-register digital wallet
- Domain registration
- Mobile Certificates (Apple Pay)
Anti-fraud services
Gift-card services

Other

Flow
Merchant accounts
Reports
Report executions
Webhook subscriptions

Errors

GET

digital-wallets

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/digital-wallets \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "digital-wallet",
      "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
      "merchant_account_id": "default",
      "provider": "apple",
      "merchant_name": "Gr4vy",
      "merchant_url": "https://example.com",
      "merchant_display_name": "Gr4vy",
      "merchant_country_code": "US",
      "domain_names": [
        "example.com"
      ],
      "fields": {
        "digital_payment_application_id": "<string>",
        "digital_payment_application_name": "<string>"
      },
      "created_at": "2012-12-12T10:53:43+00:00",
      "updated_at": "2012-12-12T10:53:43+00:00",
      "active_certificate_count": 1,
      "pending_certificate_count": 1,
      "expired_certificate_count": 1
    }
  ]
}

This endpoint requires the digital-wallets.read scope.

Authorizations

Authorization

string

header

required

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

Response

200

application/json

Returns a list of registered digital wallets.

A list of registered digital wallets.

items

object[]

A list of registered digital wallets.

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

items.type

enum<string>

digital-wallet.

Available options:

digital-wallet

Example:

"digital-wallet"

items.id

string

The ID of the registered digital wallet.

Example:

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

items.merchant_account_id

string

The unique ID for a merchant account.

Example:

"default"

items.provider

enum<string>

The name of the digital wallet provider.

Available options:

apple,

google

Example:

"apple"

items.merchant_name

string

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

Example:

"Gr4vy"

items.merchant_url

string | null

The main URL of the merchant.

Example:

"https://example.com"

items.merchant_display_name

string | null

The consumer facing name of the merchant.

Example:

"Gr4vy"

items.merchant_country_code

string | null

The country code where the merchant is registered.

Required string length: 2

Example:

"US"

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.

Example:

["example.com"]

items.fields

object

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

items.created_at

string

The date and time when this digital wallet was registered.

Example:

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

items.updated_at

string

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

Example:

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

items.active_certificate_count

integer

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

Example:

1

items.pending_certificate_count

integer

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

Example:

1

items.expired_certificate_count

integer

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

Example:

1

Was this page helpful?

Verify credentials Get digital wallet

curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/digital-wallets \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "type": "digital-wallet",
      "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
      "merchant_account_id": "default",
      "provider": "apple",
      "merchant_name": "Gr4vy",
      "merchant_url": "https://example.com",
      "merchant_display_name": "Gr4vy",
      "merchant_country_code": "US",
      "domain_names": [
        "example.com"
      ],
      "fields": {
        "digital_payment_application_id": "<string>",
        "digital_payment_application_name": "<string>"
      },
      "created_at": "2012-12-12T10:53:43+00:00",
      "updated_at": "2012-12-12T10:53:43+00:00",
      "active_certificate_count": 1,
      "pending_certificate_count": 1,
      "expired_certificate_count": 1
    }
  ]
}