Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Digital wallets

List digital wallet tokens

Returns a list of digital wallet tokens for cards on a given account.

Each digital wallet token represents a specific card, wallet and device combination.

We support Apple Pay, Google Pay, and Samsung Pay wallets.

get/cards/tokens

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
personIdstring uuid

The ID of the person to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a04
tokenState'REQUESTED' | 'REQUEST_DECLINED' | 'ACTIVE' | 'SUSPENDED' | 'TERMINATED'

The state of the token

Example:ACTIVE
searchstring

List of comma-separated last four digits.

Example:1234,3453,2222
tokenType'APPLE_PAY' | 'ANDROID_PAY' | 'SAMSUNG_PAY'

The type of wallet token.

Example:APPLE_PAY
deviceType'MOBILE_PHONE' | 'TABLET' | 'WATCH'

The type of device into which the digital wallet token is provisioned.

Example:WATCH
deviceIdstring

The device ID associated with the digital wallet token for Apple Pay, Google Pay, or Samsung Pay.

Example:b39f54264a3d

Response

OK

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "count": 67,
  "rows": [
    {
      "token": "9d3dee7c-19df-4b71-bbb9-521bb04307bf",
      "deviceId": "b39f54264a3d",
      "cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "cardName": "Expense card",
      "lastFour": "0056"
    }
  ]
}