Checkout Custom Card Payment API
The Checkout Custom Card Cayment API allows flows for credit card tokenization in VTEX, covering profile management, card token vault operations, checkout processes, payment gateway interactions, and authentication workflows.
This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.
Endpoints
Profile management
| Summary | Method | Path |
|---|---|---|
| Create profile | POST | /api/profile-system/pvt/profiles |
| Get profile cards | GET | /api/profile-system/pvt/profiles/{profileId}/vcs-checkout |
| Delete profile | DELETE | /api/profile-system/pvt/profiles/{profileId}/personalData |
Card token vault
| Summary | Method | Path |
|---|---|---|
| Save card token | POST | /api/card-token-vault/tokens |
Checkout operations
| Summary | Method | Path |
|---|---|---|
| Add items to cart | POST | /api/checkout/pub/orderForm/{orderFormId}/items |
| Add client profile data | POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData |
| Add payment data | POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData |
| Place order | POST | /api/checkout/pub/orderForm/{orderFormId}/transaction |
Authentication
| Summary | Method | Path |
|---|---|---|
| Start client login | POST | /api/vtexid/pub/authentication/startlogin |
| Validate client login | POST | /api/vtexid/pub/authentication/classic/validate |
Payment gateway
| Summary | Method | Path |
|---|---|---|
| Get transaction details | GET | /api/pvt/transactions/{transactionId} |
| List payments | GET | /api/pvt/transactions/{transactionId}/payments |
| Get card | GET | /api/pvt/accounts/{accountId} |