Card Token Vault API
The Card Token Vault API allows VTEX merchants to manage card tokens, including creation, updates, retrieval, deletion, and bulk imports. Card tokens are unique identifiers that represent securely stored credit card data.
This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Support.
The endpoints of this API can be used for personal cards (cards associated with a single buyer) and shared cards (cards used by more than one person and associated with a specific contract). However, in a scenario of operations with personal cards, the
shopperIdmust be additionally sent on the Created card token or Updated card token endpoints.
Endpoints
Card token
| Summary | Method | Path |
|---|---|---|
| Create card token | POST | /api/card-token-vault/tokens |
| Update card token | PUT | /api/card-token-vault/tokens/{id} |
| Get card token by ID | GET | /api/payments/pvt/accounts/{id} |
| Delete card token | DELETE | /api/payments/pvt/accounts/{id} |
Card token import
| Summary | Method | Path |
|---|---|---|
| Import card tokens | POST | /api/card-token-vault/tokens/import |
| Get card token import status | GET | /api/card-token-vault/tokens/import/{importId} |
| Get card token import report | GET | /api/card-token-vault/tokens/import/{importId}/report |