---
title: "Cria uma sessão de checkout hospedado"
method: POST
path: "/v1/checkout-sessions"
tags: ["Checkout Sessions"]
---

# Cria uma sessão de checkout hospedado

`POST /v1/checkout-sessions`

## Request

- Base URL: `https://api.sandbox.mupag.com.br`
- URL: `https://api.sandbox.mupag.com.br/v1/checkout-sessions`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateCheckoutSessionRequest
  - `items` CheckoutItemRequest[], required
    - `name` string, required
    - `quantity` integer, required
    - `unit_amount_cents` integer, required
  - `success_url` string, uri, required
  - `cancel_url` string, uri, required
  - `customer_id` string, uuid
  - `customer_data` CheckoutCustomerDataRequest
    - `name` string
    - `email` string, email
    - `document` string
    - `phone` string
  - `allowed_payment_methods` string[]
  - `affiliate_code` string
  - `coupon_id` string, uuid
  - `utm_params` object
  - `expires_in_minutes` integer
  - `metadata` object: JSON limitado a 4 níveis, 200 nós, strings de até 1000 caracteres e peso estrutural total de 16 KiB.
  - `collect_shipping_address` boolean
  - `delivery_type` string
  - `allow_coupons` boolean: Omissão ou null preserva o comportamento legado e permite cupons.

## Response `201`

Sessão criada

- CreateCheckoutSessionResponse
  - `id` string, uuid, required
  - `url` string, required
  - `expires_at` string, date-time, required

## Other responses

- `401`: Falha de autenticação
- `403`: Permissão insuficiente
- `409`: Conflito de idempotência ou estado
- `422`: Erro de validação
- `429`: Limite de requisições excedido

---

[API](https://skmtc.dev/mupag/apis/mupag-public-merchant-api.md) · [All operations](https://skmtc.dev/mupag/apis/mupag-public-merchant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mupag/apis/mupag-public-merchant-api/revisions/677904516d2d?raw)