---
title: "Criar Checkout Transparente"
method: POST
path: "/transparents/create"
---

# Criar Checkout Transparente

`POST /transparents/create`

Cria um checkout transparente. Use `"method": "PIX"` para gerar um QR Code ou `"method": "BOLETO"` para emitir um boleto com PIX alternativo incluído.

## Request body

- object
  - `method` 'PIX' | 'BOLETO', required — Método de pagamento.
  - `data` object, required — Dados da cobrança.
    - `amount` number, required — Valor da cobrança em centavos.
    - `expiresIn` number — PIX — tempo de expiração em segundos. Não se aplica a `method: "BOLETO"` (use `dueDate`).
    - `dueDate` string, date — BOLETO — data de vencimento no formato `YYYY-MM-DD` (ex: `"2026-08-15"`). Opcional. Se omitido, o vencimento padrão é de 3 dias úteis. Não pode ser data no passado. Máximo de 365 dias no futuro. Ignorado quando `method` é `PIX`.
    - `description` string — Descrição da cobrança.
    - `customer` object — Dados do pagador. Obrigatório para BOLETO (`name` e `taxId` sempre exigidos). Para PIX, se informado, todos os campos são obrigatórios.
      - `name` string, required
      - `taxId` string, required
      - `email` string
      - `cellphone` string
    - `externalId` string — ID no seu sistema para idempotência.
    - `interest` BoletoInterest — Juros por atraso aplicados ao boleto após o vencimento. Late interest applied to the boleto after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required — Percentual de juros ao mês em centésimos de percentual (`100` = 1% ao mês, `250` = 2,5% ao mês). Quando `0` ou omitido, sem juros. Calculado pro rata die após o vencimento. EN: Monthly late-interest rate in hundredths of a percent (`100` = 1%/month). Accrues pro rata die after the due date; `0` or omitted disables interest.
    - `fine` BoletoFine — Multa por atraso aplicada uma única vez após o vencimento do boleto. One-time late fine applied after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required — Quando `type = "PERCENTAGE"`: centésimos de percentual sobre o valor do boleto (`200` = 2%). Quando `type = "FIXED"`: valor fixo em centavos (`1000` = R$ 10,00). Quando `0` ou omitido, sem multa. EN: With `type: "PERCENTAGE"`, value is in hundredths of a percent (`200` = 2%). With `type: "FIXED"`, value is in cents (`1000` = R$ 10.00). `0` or omitted disables the fine.
      - `type` 'PERCENTAGE' | 'FIXED', required — Tipo da multa. `PERCENTAGE` aplica percentual sobre o valor do boleto; `FIXED` aplica um valor fixo em centavos. EN: Fine type. `PERCENTAGE` applies a percent of the boleto amount; `FIXED` applies a fixed amount in cents.
    - `metadata` object
    - `utm` TransparentCreateUtm — Parâmetros UTM opcionais para campanha. Objeto inteiro e campos internos opcionais; podem ser consultados no dashboard.
      - `source` string — Opcional — ex.: origem ou fonte da campanha.
      - `medium` string — Opcional — ex.: meio ou canal.
      - `campaign` string — Opcional — nome ou identificador da campanha.
      - `term` string — Opcional — ex.: palavras-chave de anúncio.
      - `content` string — Opcional — ex.: variante criativa ou conteúdo.

## Response `200`

Checkout transparente criado com sucesso

- object
  - `data` TransparentCharge — Dados da cobrança retornados pelo checkout transparente. Os campos `brCode` e `brCodeBase64` são sempre retornados (PIX direto ou PIX alternativo do boleto). Para boleto também retornam `barCode` e `url`.
    - `id` string — Identificador único da cobrança.
    - `amount` number — Valor a ser pago em centavos.
    - `status` 'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'UNDER_DISPUTE' | 'REFUNDED' | 'REDEEMED' | 'APPROVED' | 'FAILED' — Status atual da cobrança.
    - `devMode` boolean — Indica se a cobrança foi criada em ambiente sandbox.
    - `brCode` string — Código copia-e-cola do QR Code PIX. Para `method: "BOLETO"`, representa o PIX alternativo da mesma cobrança.
    - `brCodeBase64` string — Imagem em Base64 do QR Code PIX. Para `method: "BOLETO"`, representa o PIX alternativo da mesma cobrança.
    - `barCode` string — Linha digitável do boleto para pagamento no app do banco. Retornado quando `method` é `"BOLETO"`.
    - `url` string — URL para visualização e impressão do boleto. Retornado quando `method` é `"BOLETO"`.
    - `platformFee` number — Taxa da plataforma em centavos.
    - `interest` BoletoInterest — Juros por atraso aplicados ao boleto após o vencimento. Late interest applied to the boleto after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required — Percentual de juros ao mês em centésimos de percentual (`100` = 1% ao mês, `250` = 2,5% ao mês). Quando `0` ou omitido, sem juros. Calculado pro rata die após o vencimento. EN: Monthly late-interest rate in hundredths of a percent (`100` = 1%/month). Accrues pro rata die after the due date; `0` or omitted disables interest.
    - `fine` BoletoFine — Multa por atraso aplicada uma única vez após o vencimento do boleto. One-time late fine applied after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required — Quando `type = "PERCENTAGE"`: centésimos de percentual sobre o valor do boleto (`200` = 2%). Quando `type = "FIXED"`: valor fixo em centavos (`1000` = R$ 10,00). Quando `0` ou omitido, sem multa. EN: With `type: "PERCENTAGE"`, value is in hundredths of a percent (`200` = 2%). With `type: "FIXED"`, value is in cents (`1000` = R$ 10.00). `0` or omitted disables the fine.
      - `type` 'PERCENTAGE' | 'FIXED', required — Tipo da multa. `PERCENTAGE` aplica percentual sobre o valor do boleto; `FIXED` aplica um valor fixo em centavos. EN: Fine type. `PERCENTAGE` applies a percent of the boleto amount; `FIXED` applies a fixed amount in cents.
    - `receiptUrl` string, nullable — URL do comprovante de pagamento. Preenchido após o pagamento ser confirmado; `null` enquanto a cobrança estiver pendente.
    - `expiresAt` string — Data de expiração da cobrança (ISO 8601). Para boleto, corresponde ao fim do dia de `dueDate` (ou do vencimento padrão de 3 dias úteis, se `dueDate` não foi informado).
    - `createdAt` string — Data de criação.
    - `updatedAt` string — Data da última atualização.
    - `metadata` object — Campos livres enviados na requisição.
  - `error` string, nullable
  - `success` boolean — Se a requisição obteve sucesso ou não.

## Other responses

- `401` — Não autorizado. Falha na autenticação.

---

[API](https://skmtc.net/abacatepay/apis/api-abacatepay.md) · [All operations](https://skmtc.net/abacatepay/apis/api-abacatepay/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/abacatepay/api-abacatepay/revisions/2153a0f133cb/schema)