---
title: "Search Tokens"
method: GET
path: "/rest/v2/tokens"
tags: ["Tokens"]
---

# Search Tokens

`GET /rest/v2/tokens`

Retrieve the list of payment tokens based on filter criteria. Enabling multi-merchant support, the search includes tokens across all related merchants.

## Query parameters

- `token-id` string
- `merchant-legacy-token-id` string
- `updated-start-date` string
- `updated-end-date` string
- `date-filter` 'custom_range' | 'last_24_hours' | 'yesterday' | 'last_week' | 'last_month' | 'last_180_days'
- `date-format` 'MM-dd-yyyy hh:mm a' | 'MM-dd-yy HH:mm' | 'MM-dd-yy HH:mm z' | 'yyyy-MM-dd HH:mm' | 'yyyy-MM-dd HH:mm z'
- `page` string
- `page-size` string
- `isDescending` 'true' | 'false'

## Headers

- `api-key` string, required

## Response `200`

Success

- TokenResponsesPayload
  - `payloadType` string — Type of payload returned in the response.
  - `tokens` TokenResponses
    - `token` TokenResponse[]
      - `authorization-code` string — Code used to authorize the original transaction associated with the token.
      - `avs-address` string — Address used for AVS (Address Verification Service) during token creation.
      - `avs-zip` string — ZIP code used for AVS during token creation.
      - `card-type` string — Type of card associated with the token. For example, VISA, MasterCard.
      - `created` string — Timestamp when the token was created.
      - `description` string — Optional description or label for the token. For example, account type.
      - `exp-date` string — Expiration date of the card in MMYY format.
      - `last-four-digits` string — Last four digits of the card number.
      - `merchant-id` string — Identifier for the merchant who created the token.
      - `merchant-legacy-token-id` string — Merchant-defined identifier for the token.
      - `software-vendor-name` string — Name of the software vendor that processed the token.
      - `status` string — Current status of the token. For example, Active, Inactive.
      - `times-used` string — Number of times the token has been used in transactions.
      - `token-id` string — Xplor Pay-generated unique identifier for the token.
      - `token-status` 'Open' | 'Closed' | 'Suspended' — Operational state of the token. For example, Open, Closed.
      - `updated` string — Timestamp of the last update to the token.
      - `avs-result-code` 'X' | 'Y' | 'A' | 'W' | 'Z' | 'N' | 'U' | 'R' | 'S' | 'G' — Result code from the AVS check. For example, X = match.
      - `customer-first-name` string — First name of the customer associated with the token.
      - `customer-key` string — Unique identifier for the customer.
      - `customer-last-name` string — Last name of the customer associated with the token.
      - `default` boolean — Indicates whether this token is marked as the default for the customer.
      - `token-update-status` 'UPDATED' | 'CLOSED' | 'NOT_PARTICIPATING' | 'CONTACT CARD HOLDER' | 'VALID CARD NO UPDATE' — Status indicating the result of the update operation. For example, UPDATED.

## Other responses

- `204` — No Content
- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `500` — Server Error

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/versions/f37077c24b66/schema)