> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkout transparente

> Receba Pix, boleto e cartão de crédito dentro do seu site ou app, sem redirecionar o cliente para outra página. Veja como funciona e quando usar.

No checkout transparente, o pagamento acontece dentro do seu site ou app. Você monta a tela de compra, a AbacatePay processa o Pix, o boleto ou o cartão por trás, e o cliente não sai da sua página.

## Quando usar o checkout transparente

Use quando você já tem a sua tela de compra e quer a sua marca do começo ao fim, com menos cliques e sem redirecionamento. Ele exige desenvolvimento: tudo é feito pela API. Se você ainda não tem time de tecnologia, comece pelo [checkout](https://docs.abacatepay.com/pages/cobrar/checkout.md).

| | Checkout | Checkout transparente |
| - | - | - |
| Onde o cliente paga | Na página da AbacatePay | No seu site ou app |
| Precisa de programador | Não: dá para criar pelo dashboard | Sim: só pela API |
| Visual | O da AbacatePay, com a sua [personalização](https://docs.abacatepay.com/pages/cobrar/checkout.md#como-personalizar-o-checkout) | O seu |
| O que você cobra | Produtos cadastrados | Um valor (`amount`) |
| Formas de pagamento | Pix, cartão, boleto, Apple Pay e Google Pay | Pix, boleto e cartão |
| Rota para criar | `POST /checkouts/create` | `POST /transparents/create` |
| Webhooks | `checkout.*` | `transparent.*` |

## Como funciona o checkout transparente

```mermaid theme={null}
sequenceDiagram
    participant C as Cliente
    participant S as Seu sistema
    participant A as AbacatePay
    C->>S: Finaliza a compra no seu site
    S->>A: POST /transparents/create
    A-->>S: Pix, boleto ou resultado do cartão
    S->>C: Mostra o QR Code, o boleto ou o resultado
    C->>A: Paga
    A->>S: Webhook transparent.completed
```

Os três métodos usam a mesma rota, `POST /transparents/create`, e mudam no campo `method`:

| `method` | O que a AbacatePay devolve | Detalhes |
| - | - | - |
| `PIX` | O QR Code em imagem e o código copia e cola, para mostrar na sua página | [Pix](https://docs.abacatepay.com/pages/pagamentos/pix.md) |
| `BOLETO` | O boleto, com um Pix junto para o cliente pagar como preferir | [Boleto](https://docs.abacatepay.com/pages/pagamentos/boleto.md) |
| `CARD` | O resultado da cobrança no cartão, à vista ou parcelado | [Cartão de crédito](https://docs.abacatepay.com/pages/pagamentos/cartao-de-credito.md) |

No cartão, o número nunca passa pelo seu servidor. O formulário de cartão é um campo seguro da AbacatePay dentro da sua página, o [abacatepay.js](https://docs.abacatepay.com/pages/transparents/abacatepay-js.md). Ele gera um token, e o seu backend cobra com esse token. O cartão precisa estar liberado na sua conta e aceita Visa e Mastercard. O passo a passo completo está em [Checkout transparente com cartão](https://docs.abacatepay.com/pages/cobrar/checkout-transparente-cartao.md).

Para cobrar de novo um cartão que o cliente já usou, sem ele digitar nada, veja [One click buy](https://docs.abacatepay.com/pages/pagamentos/one-click-buy.md). Para rastrear campanhas e guardar dados do seu sistema na cobrança, veja [UTM e metadados](https://docs.abacatepay.com/pages/vender/utm-e-metadados.md).

## Pelo dashboard

O checkout transparente só é criado pela API. No dashboard, as cobranças aparecem em **Sua Loja → Cobranças**, na aba **Checkout Transparente**. A chave pública do cartão fica em **Integração → Checkout próprio**.

## Pela API

Crie uma chave de API com a permissão `TRANSPARENT:CREATE` em **Integração → API**. Veja [Chaves de API](https://docs.abacatepay.com/pages/comecar/chaves-de-api.md).

| Endpoint | O que faz |
| - | - |
| [Criar cobrança Pix](https://docs.abacatepay.com/pages/transparents/create.md) | `POST /transparents/create` com `method: "PIX"` |
| [Criar cobrança Boleto](https://docs.abacatepay.com/pages/transparents/boleto.md) | `POST /transparents/create` com `method: "BOLETO"` |
| [Criar cobrança Cartão](https://docs.abacatepay.com/pages/transparents/card.md) | `POST /transparents/create` com `method: "CARD"` |
| [Checar status](https://docs.abacatepay.com/pages/transparents/check.md) | `GET /transparents/check`, para cobranças Pix |
| [Listar cobranças](https://docs.abacatepay.com/pages/transparents/list.md) | `GET /transparents/list` |
| [Reembolsar](https://docs.abacatepay.com/pages/transparents/refund.md) | `POST /transparents/refund`. Veja [Reembolsos](https://docs.abacatepay.com/pages/vender/reembolsos.md) |

`GET /transparents/get` e `GET /transparents/list` trazem só as cobranças do checkout transparente. Checkouts, links de pagamento e assinaturas ficam nas rotas deles.

Depois que o pagamento confirma, `receiptUrl` traz o link do comprovante. No dashboard, o botão **Ver comprovante** abre o mesmo recibo.

**Comprovante - AbacatePay**

O vídeo também está em [Comprovante](https://docs.abacatepay.com/pages/videos/comprovante.md).

## Notificações

| Evento | Quando dispara |
| - | - |
| `transparent.completed` | O pagamento foi confirmado. |
| `transparent.refunded` | O pagamento foi reembolsado. |
| `transparent.disputed` | O pagamento entrou em disputa. |
| `transparent.lost` | A disputa foi perdida. |

Os exemplos de cada evento estão em [Eventos do checkout transparente](https://docs.abacatepay.com/pages/webhooks/events/transparent.md). Para cadastrar o endereço que recebe os eventos, veja [Webhooks](https://docs.abacatepay.com/pages/notificacoes/webhooks.md).

## Testar no Modo Teste

Use uma chave de API do [Modo Teste](https://docs.abacatepay.com/pages/comecar/modo-teste.md), que começa com `abc_dev_`. No Pix, chame [Simular pagamento](https://docs.abacatepay.com/pages/transparents/simulate-payment.md) com o `id` da cobrança. No cartão, use a chave pública de teste e os [cartões de teste](https://docs.abacatepay.com/pages/comecar/modo-teste.md#cartões-de-teste).

## Perguntas frequentes

> [accordion] Preciso de programador para usar o checkout transparente?
>
> Sim. A tela de compra é sua e a cobrança é criada pela API. Sem desenvolvimento, use o [checkout](https://docs.abacatepay.com/pages/cobrar/checkout.md) ou o [link de pagamento](https://docs.abacatepay.com/pages/cobrar/link-de-pagamento.md), que você cria pelo dashboard.

> [accordion] O número do cartão passa pelo meu servidor?
>
> Não. O cliente digita o cartão num campo seguro da AbacatePay dentro da sua página, e o seu servidor recebe só um token.

> [accordion] Dá para parcelar no cartão?
>
> Sim, em até 12x. Veja [Parcelamento no cartão](https://docs.abacatepay.com/pages/pagamentos/parcelamento.md).

> [accordion] Consigo cobrar o mesmo cartão de novo?
>
> Sim. A primeira cobrança devolve um `cardToken`, que cobra o mesmo cartão sem o cliente digitar nada. Veja [One click buy](https://docs.abacatepay.com/pages/pagamentos/one-click-buy.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.