---
title: "Get customer token"
method: GET
path: "/rest/v2/customers/{customerKey}/tokens"
tags: ["Customer Token"]
---

# Get customer token

`GET /rest/v2/customers/{customerKey}/tokens`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `api-key`
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v2/customers/:customerKey/tokens/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the payment token associated with the customer identified by the specified customer key.

## Path parameters

- `customerKey` string, required

## Headers

- `api-key` string, required

## Response `200`

ok

- ClearentCustomerTokensResponsePayload: payload
  - `customer-tokens` Tokens: tokens
    - `token` CustomerToken[]
      - `customer-key` string, required: Unique identifier of the customer to associate with the token.
      - `token-id` string, required: Unique identifier of the existing payment token that represents the card number.
      - `exp-date` string, required: Expire date of the card (MMYY).
      - `card-type` 'AMEX' | 'Discover' | 'JCB' | 'MasterCard' | 'VISA', required: Type of payment card associated with the token.
      - `last-four-digits` string, required: Last four digits of the card number associated with the token.
      - `description` string: Description of the customer's card to help identify the payment method.
      - `default` boolean: Indicates whether this card is the default payment method for the customer.
      - `avs-address` string: Street address used for Address Verification Service (AVS) validation for the payment card.
      - `avs-zip` string: ZIP or postal code used for Address Verification Service (AVS) validation.
  - `payloadType` string: Type of payload returned in the response.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)
