v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB
Configuration

Get card data

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 must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
PCI GatewayPayment-ViewPaymentDataView Payment Data

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/payments/pvt/account/{cardId}

Path parameters

cardIdstring required
Example:719f3698-d8cb-41af-13a7-41f63982bcd2

Card identification. This is the accountId associated with the client's profile, which can be viewed by accessing Profile System. As a client can have more than one card registered in their profile, check the desired accountId and send it in this request.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

binstring

First six digits of the card number.

lastDigitsstring

Last four digits of the card.

expiryMonthstring

Card expiration month (2-digits).

expiryYearstring

Card expiration year (4-digits).

maskstring

Masked card number.

paymentSysteminteger

Payment system ID in the Payment Gateway.

paymentSystemNamestring

Payment system name (card brand).

documentstring

Card holder's document.