---
title: "Get card data"
method: GET
path: "/api/payments/pvt/account/{cardId}"
tags: ["Configuration"]
---

# Get card data

`GET /api/payments/pvt/account/{cardId}`

## Request

- Base URL: `https://apiexamples.vtexpayments.com.br`
- URL: `https://apiexamples.vtexpayments.com.br/api/payments/pvt/account/{cardId}`
- Auth: none declared. Required headers: `Content-Type`, `Accept`

Retrieves the public data of a specific credit card stored in the store.

Before consulting the card details, consider the following information:
- Sensitive data such as full card number and CVV are not returned.
- The `tokens` field is optional. It is included in the response only if the card you are retrieving has already been tokenized.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| PCI Gateway | Payment-ViewPaymentData | **View Payment Data** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.

To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `cardId` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `bin` string: First six digits of the card number.
  - `lastDigits` string: Last four digits of the card.
  - `expiryMonth` string: Card expiration month (2-digits).
  - `expiryYear` string: Card expiration year (4-digits).
  - `mask` string: Masked card number.
  - `paymentSystem` integer: Payment system ID in the Payment Gateway.
  - `paymentSystemName` string: Payment system name (card brand).
  - `address` object: Card address (optional).
    - `addressType` 'Residential' | 'Commercial': Address type.
    - `addressId` string: Address ID.
    - `postalCode` string: Postal code.
    - `street` string: Street name.
    - `neighborhood` string: Neighborhood name.
    - `city` string: City name.
    - `state` string: State or province.
    - `country` string: Country code.
    - `number` string: Street number.
    - `complement` string: Address complement.
  - `document` string: Card holder's document.
  - `tokens` object: Card tokens information (optional).
    - `providerId` string: Name of the connector's owner account (`accountName`) used to create the token.
    - `type` 'FILE' | 'TOKEN_CLIENT_ID' | 'TOKEN_VALUE': Token type stored in the vault.
    - `value` string: Token value.
    - `expiration` string: Token expiration date in `YYYY-MM` format.
    - `label` string: Token alias (an alternative name to simplify token identification).
    - `href` string: URL of the token file stored by the provider.
    - `providerCardTokenId` string: Client ID used to retrieve the token from the provider.
    - `useCvvForAuthorization` boolean: Flag indicating if CVV is required (`true`) or not (`false`).
    - `extraData` object: Additional metadata stored with the token.
      - `customField1` string: Custom field information.

## Other responses

- `404`: Not Found
- `500`: Internal Server Error Payment system not found for the card.

## Changes

- **2025-12-09** `73767fd99419`: 2 warning
  - added the new `Commercial` enum value to the `address/addressType` response property for the response status `200`
  - added the new `Residential` enum value to the `address/addressType` response property for the response status `200`
- **2025-12-08** `a3d639339344`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vtex/apis/payments-gateway-api/changes/api/payments/pvt/account/:cardId/get.md)

---

[API](https://skmtc.dev/vtex/apis/payments-gateway-api.md) - [All operations](https://skmtc.dev/vtex/apis/payments-gateway-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/payments-gateway-api/revisions/05de96df31e4?raw)