---
title: "Criar smart checkout"
method: POST
path: "/v1/marketplace/checkout"
tags: ["Checkout"]
---

# Criar smart checkout

`POST /v1/marketplace/checkout`

## Headers

- `establishment_id` string, required
- `integration-key` string, required
- `x-token` string, required

## Request body

- CreateCheckoutOrderDto
  - `client` ClientDto
    - `first_name` string, required — Nome/Razão Social.
    - `last_name` string — Sobrenome/Nome fantasia.
    - `email` string, required — E-mail.
    - `document` string, required — CPF ou CNPJ.
    - `phone` string — Número de telefone.
    - `address` ClientAddressDto
      - `city` string, required — Cidade.
      - `state` string, required — Estado.
      - `zip_code` string, required — CEP.
      - `street` string, required — Logradouro.
      - `complement` string — Complemento.
      - `number` string, required — Número.
      - `neighborhood` string, required — Bairro.
  - `title` string, required — Descrição do checkout.
  - `payment_order` PaymentOrderDto
    - `discounts` DiscountDto[] — Descontos por método de pagamento.
      - `method` string, required — Método de pagamento do desconto.
      - `value` number, required — Valor do desconto.
      - `type` 'PERCENTAGE' | 'CURRENCY', required — Tipo do desconto.
    - `max_number_installments` number — Número máximo de parcelas.
    - `pix_expiration_interval` number — Tempo de expiração do PIX em minutos.
    - `payment_type_allowed` string[] — Métodos de pagamento permitidos.
  - `theme` ThemeDto
    - `main` string — Cor primária.
    - `secondary` string — Cor secundária.
    - `logo_url` string — URL do logotipo.
    - `favicon_url` string — URL do favicon.
    - `wallet_icon_url` string — URL do ícone da carteira.
    - `font_family` 'roboto' | 'poppins' | 'sf-pro-text' — Tipo da fonte.
    - `card_border_radius` number — Borda do card em que fica o conteúdo (em REM)
    - `button_border_radius` number — Borda dos botões (em REM)
  - `duration` number — Tempo de expiração do link em minutos.
  - `reference_id` union — Identificador definido pelo cliente para controle e rastreamento interno do checkout.
    - string
    - number
  - `multiple_payments` boolean — Permite múltiplos pagamentos.
  - `interest` 'STORE' | 'CLIENT' — - CLIENT: as taxas são repassadas ao comprador, resultando no aumento do valor bruto da transação. - STORE: as taxas são cobradas do estabelecimento, mantendo inalterado o valor bruto da transação.
  - `brand_plan` 'MASTERCARD' | 'VISA' | 'ELO' | 'OTHERS' — Plano utilizado para calcular as taxas quando o interest for CLIENT.
  - `amount` number, required — Valor do checkout em centavos.
  - `billet` TransactionBilletDto
    - `due_date` string, required — Data de vencimento do boleto, no formato YYYY-MM-DD.
    - `issue_date` string, required — Data de emissão do boleto, no formato YYYY-MM-DD.
    - `document_kind` string — Espécie do documento (padrão = OUTROS)
    - `days_until_expiration` number — Quantidade de dias após o vencimento até que o boleto expire e não possa mais ser pago.
    - `iof_percentage` string — Percentual de IOF no formato 0.00000 (ex: 0.00820). Aplicado sobre o valor do boleto.
    - `messages` string[] — Mensagens de instrução exibidas no boleto (máximo de 3 linhas).
    - `discount` BilletDiscount
      - `type` 'VALOR_DATA_FIXA', required — Tipo de desconto.
      - `items` BilletDiscountItem[], required — Lista de descontos com até 3 itens.
        - `limit_date` string, required — Data limite para aplicação do desconto, no formato YYYY-MM-DD. Obrigatório apenas para descontos do tipo VALOR_DATA_FIXA
        - `value` number, required — Valor do desconto em centavos.
    - `fine` BilletFine
      - `percentage` string, required — Percentual de multa no formato 0.00 (ex: 2.00 representa 2%).
      - `quantity_days` number, required — Quantidade de dias de multa.
    - `interest_percentage` string — Percentual de juros ao mês no formato 0.00 (ex: 1.00 representa 1%).

## Response `200`

- CheckoutOrderResponse
  - `_id` string, required — ID do pedido de checkout.
  - `title` string, required — Descrição do checkout.
  - `checkout_token` string, required — Token do checkout.
  - `amount` number, required — Valor do checkout em centavos.
  - `status` string, required — Status do checkout.
  - `reference_id` string — Identificador definido pelo cliente para controle e rastreamento interno do checkout.
  - `created_at` string, required — Data de criação.
  - `updated_at` string, required — Data de atualização.

---

[API](https://skmtc.net/paytime/apis/api-p-blica.md) · [All operations](https://skmtc.net/paytime/apis/api-p-blica/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paytime/api-p-blica/revisions/5c818991d183/schema)