Health Pricing About ← Back
C

Checkout API

by Checkout

>ℹ️ Check the new Checkout onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing o

paymentsvtex

Quick Reference

Base URL https://vtex.local Auth type API Key Header Auth header X-VTEX-API-AppKey: YOUR_API_KEY Rate limit Not officially published Pricing Enterprise / contact sales Free quota None Documentation https://vtex.local Endpoint status Unreachable — No response — server may be down or blocking automated probes (checked Mar 29, 2026) Builder score D 37% builder-friendly
Pricing
28
Latency
0
Depth
72

Authentication

API key in the request header (X-VTEX-API-AppKey)

X-VTEX-API-AppKey: YOUR_API_KEY

Pricing

Model subscription Starting price Enterprise / contact sales Free quota None

Paid payment processing. Checkout.com: custom pricing; enterprise and growth plans.

Key Endpoints

MethodPathDescription
POST /api/checkout/pub/gatewayCallback/{orderGroup} Process order
GET /api/checkout/pub/orderForm Get current or create a new cart
GET /api/checkout/pub/orderForm/{orderFormId} Get cart information by ID
POST /api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData Add client preferences
POST /api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData Add client profile
POST /api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData Add marketing data
POST /api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData Add merchant context data
POST /api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData Add payment data

Sample Request

curl -X GET 'https://vtex.local/api/checkout/pub/gatewayCallback/{orderGroup}' \
  -H 'X-VTEX-API-AppKey: YOUR_API_KEY'

Sample Response

{}

Data sourced from API Map. Always verify pricing and rate limits against the official Checkout documentation.