# Checkout API

**Provider:** Checkout
**Category:** payments
**Base URL:** `https://vtex.local`
**Auth:** api-key — `X-VTEX-API-AppKey: YOUR_API_KEY`
**Rate Limit:** Not officially published
**Free Tier:** No
**Pricing:** Enterprise / contact sales (subscription)
**Docs:** https://vtex.local

## Description

>ℹ️ 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

## Endpoints

| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | `https://vtex.local/api/checkout/pub/gatewayCallback/{orderGroup}` | Process order |
| GET | `https://vtex.local/api/checkout/pub/orderForm` | Get current or create a new cart |
| GET | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}` | Get cart information by ID |
| POST | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData` | Add client preferences |
| POST | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData` | Add client profile |
| POST | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData` | Add marketing data |
| POST | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData` | Add merchant context data |
| POST | `https://vtex.local/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData` | Add payment data |

## Authentication

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

```
X-VTEX-API-AppKey: YOUR_API_KEY
```

## Sample Request

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

## Sample Response

```json
{}
```

## Pricing Details

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

---

*Source: [API Map](https://apimap.dev/apis/checkout/) — CC BY 4.0*