View digital wallet tokens

Retrieve a list of digital wallet tokens associated with an account.

List digital wallet tokens

Get/v2/cards/tokens

Request

Use this request to get a list of digital wallet tokens for cards on a given account.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/tokens?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/tokens?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Query parameters

Parameter	Description
`accountId` string required	The ID of the account that the tokens are associated with. Allowable values: An existing `accountId`
`personId` string (uuid)	The ID of the person that the tokens are associated with. Allowable values: An existing `personId` (<= 36 characters)
`state` string (enum)	The state of the token. For example, `state=ACTIVE`. Allowable values: `REQUESTED`, `REQUEST_DECLINED`, `ACTIVE`, `SUSPENDED`, `TERMINATED`
`search` string	The last four digits of the card to search for. Use a comma-separated list to search for more than one. For example, `search=1234,4321`. Allowable values: A valid string
`type` string (enum)	The type of digital wallet token. For example, `type=APPLE_PAY`. Allowable values: `APPLE_PAY`, `ANDROID_PAY`, `SAMSUNG_PAY`
`deviceType` string (enum)	The type of device. For example, `type=WATCH`. Allowable values: `MOBILE_PHONE`, `TABLET`, `WATCH`

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

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

Copy

Copied

{
  "count": integer,
  "rows": [
    {
      "token": "string",
      "cardId": "string",
      "cardName": "string",
      "lastFour": "string"
    }
  ]
}

For more detailed information about this request and its response, see the API reference.