# Cakto API

- [Introdução](https://docs.cakto.com.br/introduction.md): Entenda conceitos, pré-requisitos e funcionamento da API Cakto.
- [Autenticação](https://docs.cakto.com.br/authentication.md)
- [Changelog](https://docs.cakto.com.br/mudancas.md): Mudanças no contrato da API pública, da mais recente para a mais antiga.
- [Primeira chamada em 5 minutos](https://docs.cakto.com.br/comece-aqui/primeira-chamada.md): Do zero à sua primeira resposta da API Cakto, sem rodeios.
- [Criar um checkout](https://docs.cakto.com.br/comece-aqui/criar-checkout.md): Na Cakto, criar um produto já cria o checkout. Veja o fluxo completo via API.
- [Receber sua primeira venda](https://docs.cakto.com.br/comece-aqui/receber-primeira-venda.md): Crie um produto, configure um webhook e veja o evento de venda chegar na sua aplicação.
- [Glossário](https://docs.cakto.com.br/conceitos/glossario.md): Como produto, oferta, checkout, pedido e assinatura se relacionam na Cakto.
- [Ambientes](https://docs.cakto.com.br/conceitos/ambientes.md): A URL de produção, como pedir acesso a staging, e por que o link de checkout usa outro domínio.
- [Fluxo de pagamento](https://docs.cakto.com.br/conceitos/fluxo-de-pagamento.md): Os dois caminhos para receber pela Cakto: link de checkout hospedado ou cobrança direta pela API.
- [Validação do número do cartão](https://docs.cakto.com.br/conceitos/validacao-de-cartao.md): O dígito verificador (algoritmo de Luhn): o que é, o que a Cakto faz com ele e como conferir antes de chamar a API.
- [Estrutura do Checkout (Checkout Builder)](https://docs.cakto.com.br/conceitos/checkout-builder.md): O que pode ir dentro do campo config: dispositivos, blocos disponíveis, atributos válidos e como imagens funcionam.
- [Redirect pós-pagamento](https://docs.cakto.com.br/conceitos/redirect-pos-pagamento.md): Leve o comprador de volta ao seu sistema depois da aprovação, com um identificador daquela compra na URL.
- [Guia de Webhooks](https://docs.cakto.com.br/conceitos/webhooks.md): Como a Cakto entrega eventos, como validar a origem e como tratar retentativas.
- [Idempotência](https://docs.cakto.com.br/conceitos/idempotencia.md): Como reenviar uma requisição com segurança sem gerar cobranças duplicadas.
- [Paginação](https://docs.cakto.com.br/conceitos/paginacao.md): Como percorrer listagens da API: parâmetros, tetos por endpoint e como ler o total corretamente.
- [Limites de Requisição](https://docs.cakto.com.br/conceitos/rate-limits.md): Quantas requisições sua integração pode enviar e como reagir ao limite.
- [Erros](https://docs.cakto.com.br/conceitos/erros.md): Formato das respostas de erro e o que fazer em cada código de status.
- [Visão Geral](https://docs.cakto.com.br/sdk/visao-geral.md): Tokenize cartões, autentique com 3DS e colete perfil antifraude direto no browser.
- [Antifraude](https://docs.cakto.com.br/sdk/antifraude.md): Colete sinais do dispositivo do comprador para a análise de risco da Cakto.
- [Tokenização de Cartão](https://docs.cakto.com.br/sdk/tokenizacao.md): Troque os dados do cartão por um token de uso único, sem trafegar o cartão pelo seu servidor.
- [3D Secure (3DS)](https://docs.cakto.com.br/sdk/3ds.md): Autentique o portador do cartão no banco emissor antes da cobrança e processe o pagamento.
- [CaktoMCP](https://docs.cakto.com.br/mcp/visao-geral.md): Conecte assistentes de IA à API da Cakto via protocolo MCP (Model Context Protocol).
- [Ferramentas de Descoberta](https://docs.cakto.com.br/mcp/ferramentas-de-descoberta.md): As ferramentas do CaktoMCP que funcionam sem nenhuma credencial.
- [Ferramentas de Execução](https://docs.cakto.com.br/mcp/ferramentas-de-execucao.md): Como o CaktoMCP executa operações reais — com credencial, confirmação e idempotência.
- [Guias](https://docs.cakto.com.br/mcp/guias.md): Como o CaktoMCP lê esta documentação em tempo real, via cakto_search_docs e cakto_get_guide.
- [Criar Cobrança Pix](https://docs.cakto.com.br/api-reference/payments/create-pix.md): Cria uma cobrança Pix transacional a partir de uma oferta da sua conta. Retorna o QR Code copia-e-cola (BR Code) para exibição ao pagador.
- [Criar Cobrança Pix Automático](https://docs.cakto.com.br/api-reference/payments/create-pix-auto.md): Inicia uma autorização de débito automático via Pix Automático. O cliente escaneia o QR Code para autorizar cobranças futuras recorrentes — não é uma cobrança pontual.
- [Criar Cobrança Cartão](https://docs.cakto.com.br/api-reference/payments/create-card.md): Processa um pagamento por cartão de crédito a partir de uma oferta da sua conta. Requer um token de cartão obtido previamente no front-end via SDK.
- [Criar Cobrança 3DS](https://docs.cakto.com.br/api-reference/payments/create-3ds.md): Processa um pagamento por cartão de crédito com autenticação 3DS. Requer token de cartão e dados da autenticação 3DS obtidos previamente no front-end.
- [Listar Pedidos](https://docs.cakto.com.br/api-reference/orders/list.md): Lista pedidos da sua conta com suporte a filtros, busca e paginação
- [Obter Pedido](https://docs.cakto.com.br/api-reference/orders/retrieve.md): Retorna os detalhes de um pedido específico
- [Reembolsar Pedido](https://docs.cakto.com.br/api-reference/orders/refund.md): Solicita o reembolso de um pedido específico
- [Reenviar Email de Aprovação](https://docs.cakto.com.br/api-reference/orders/resend-approved-email.md): Reenvia o email de confirmação de pagamento aprovado
- [Reenviar Acesso](https://docs.cakto.com.br/api-reference/orders/resend-access.md): Cria ou atualiza acessos de um pedido existente.
- [Analytics de Vendas](https://docs.cakto.com.br/api-reference/orders/analytics.md): Descubra quais canais, campanhas e origens de tráfego geram mais vendas e receita. Tome decisões baseadas em dados para otimizar seus investimentos em marketing e aumentar o retorno sobre cada real gasto.
- [Listar Reembolsos](https://docs.cakto.com.br/api-reference/refunds/list.md): Reembolsos dos seus produtos: os pedidos pelo comprador e os já devolvidos.
- [Consultar Reembolso](https://docs.cakto.com.br/api-reference/refunds/retrieve.md): Estado de um reembolso: pedido pelo comprador, em efetivação ou devolvido.
- [Aprovar Reembolso](https://docs.cakto.com.br/api-reference/refunds/approve.md): Antecipa o reembolso pedido pelo comprador, sem esperar o fim da janela.
- [Listar Webhooks](https://docs.cakto.com.br/api-reference/webhooks/list.md): Lista webhooks da sua conta com suporte a filtros, busca e paginação
- [Criar Webhook](https://docs.cakto.com.br/api-reference/webhooks/create.md): Cria um novo webhook para receber eventos do Cakto
- [Obter Webhook](https://docs.cakto.com.br/api-reference/webhooks/retrieve.md): Retorna os detalhes de um webhook específico
- [Atualizar Webhook](https://docs.cakto.com.br/api-reference/webhooks/update.md): Atualiza as configurações de um webhook existente
- [Deletar Webhook](https://docs.cakto.com.br/api-reference/webhooks/delete.md): Deleta um webhook da sua conta
- [Histórico de Eventos do Webhook](https://docs.cakto.com.br/api-reference/webhooks/event-history.md): Lista o histórico de eventos dos webhooks associados ao usuário autenticado com suporte a filtros, busca e paginação
- [Reenviar Evento do Webhook](https://docs.cakto.com.br/api-reference/webhooks/resend-event.md): Reenvia um evento específico do histórico de eventos de um webhook
- [Evento de Teste Webhook](https://docs.cakto.com.br/api-reference/webhooks/test-webhook.md): Envia um evento de teste para o webhook especificado
- [Listar Produtos](https://docs.cakto.com.br/api-reference/products/list.md): Lista produtos da sua conta com suporte a filtros, busca e paginação
- [Criar Produto](https://docs.cakto.com.br/api-reference/products/create.md): Cria um novo produto. A criação já gera automaticamente a oferta padrão, o checkout e o link de pagamento.
- [Obter Produto](https://docs.cakto.com.br/api-reference/products/retrieve.md): Retorna informações detalhadas de um produto específico
- [Atualizar Produto](https://docs.cakto.com.br/api-reference/products/update.md): Atualiza um produto existente
- [Duplicar Produto](https://docs.cakto.com.br/api-reference/products/duplicate.md): Cria uma cópia de um produto existente
- [Deletar Produto](https://docs.cakto.com.br/api-reference/products/delete.md): Deleta um produto da sua conta
- [Listar Checkouts](https://docs.cakto.com.br/api-reference/checkouts/list.md): Lista todos os checkouts de um produto
- [Obter Checkout](https://docs.cakto.com.br/api-reference/checkouts/retrieve.md): Retorna informações detalhadas de um checkout específico
- [Personalizar Checkout](https://docs.cakto.com.br/api-reference/checkouts/update.md): Personalize a aparência e comportamento da página de checkout. Atualize a experiência de compra do cliente com configurações visuais e componentes customizados.
- [Deletar Checkout](https://docs.cakto.com.br/api-reference/checkouts/delete.md): Deleta um checkout de um produto
- [Listar Ofertas](https://docs.cakto.com.br/api-reference/offers/list.md): Lista ofertas dos seus produtos com suporte a filtros, busca e paginação
- [Criar Oferta](https://docs.cakto.com.br/api-reference/offers/create.md): Cria uma nova oferta para um produto existente
- [Obter Oferta](https://docs.cakto.com.br/api-reference/offers/retrieve.md): Retorna informações detalhadas de uma oferta específica
- [Atualizar Oferta](https://docs.cakto.com.br/api-reference/offers/update.md): Atualiza uma oferta existente
- [Deletar Oferta](https://docs.cakto.com.br/api-reference/offers/delete.md): Deleta uma oferta de um produto
- [Listar Order Bumps do Produto](https://docs.cakto.com.br/api-reference/order-bumps/list.md): Consulte as ofertas adicionais exibidas no checkout de um produto. Use este endpoint para listar, auditar e planejar as ofertas complementares que aumentam o valor médio do pedido.
- [Obter Order Bump](https://docs.cakto.com.br/api-reference/order-bumps/retrieve.md): Consulte os detalhes completos de um order bump específico. Útil para auditar a configuração antes de editar ou comparar com outros.
- [Criar Order Bump](https://docs.cakto.com.br/api-reference/order-bumps/create.md): Adicione uma oferta complementar ao checkout de um produto. Escolha a oferta, defina o preço de referência e a copy que será exibida no momento da compra.
- [Atualizar Posições dos Order Bumps](https://docs.cakto.com.br/api-reference/order-bumps/position-update.md): Altere a ordem de exibição dos order bumps no checkout. A posição define qual oferta aparece primeiro para o cliente.
- [Atualizar Order Bump](https://docs.cakto.com.br/api-reference/order-bumps/update.md): Altere a oferta, preço, copy ou imagem de um order bump existente. Use para otimizar conversão sem precisar recriar a oferta do zero.
- [Deletar Order Bump](https://docs.cakto.com.br/api-reference/order-bumps/delete.md): Remova um order bump do checkout. Use quando uma oferta complementar não está convertendo ou precisa ser substituída.
- [Listar Clientes](https://docs.cakto.com.br/api-reference/customers/list.md): Consulte sua base de compradores pagantes para análises, integrações com CRM, segmentação de campanhas e acompanhamento do relacionamento com clientes.
- [Obter Cliente](https://docs.cakto.com.br/api-reference/customers/retrieve.md): Acesse o perfil completo de um cliente, incluindo histórico de compras, métricas de gastos e transações recentes para personalizar atendimento e estratégias de fidelização.
- [Solicitar Saque](https://docs.cakto.com.br/api-reference/withdrawals/create.md): Solicita o saque do seu saldo disponível para a chave Pix cadastrada no painel.
- [Consultar Saque](https://docs.cakto.com.br/api-reference/withdrawals/retrieve.md): Estado de um saque solicitado: em análise, pago ou recusado.
- [Listar Saques](https://docs.cakto.com.br/api-reference/withdrawals/list.md): Histórico de saques da conta, do mais recente para o mais antigo.
- [Saldo](https://docs.cakto.com.br/api-reference/balance/retrieve.md): Consulte quanto está disponível para saque agora e quanto ainda vai liberar. É a mesma informação do cartão de saldo do painel.
- [Agenda de Recebimentos](https://docs.cakto.com.br/api-reference/balance/schedule.md): Veja quanto libera em cada dia. É a mesma apuração da tela Agenda Financeira do painel.
- [Taxas e Prazos](https://docs.cakto.com.br/api-reference/fees/retrieve.md): Consulte as taxas e os prazos de recebimento vigentes da sua conta, por método de pagamento, e a tabela de juros do parcelamento no cartão. É a mesma informação da tela Taxas e Prazos do painel.
- [Consultar Juro Adicional](https://docs.cakto.com.br/api-reference/installment-interest/retrieve.md): Consulte o juro adicional de parcelamento que você cobra do comprador, de 2x a 12x, e se ele está sendo cobrado hoje. É o juro que você define por cima do juro-base da Cakto.
- [Configurar Juro Adicional](https://docs.cakto.com.br/api-reference/installment-interest/update.md): Define o juro adicional de parcelamento que você cobra do comprador, de 2x a 12x. A chamada substitui a tabela inteira e passa a valer no próximo pagamento.
- [Ganhos com Juro de Parcelamento](https://docs.cakto.com.br/api-reference/installment-interest/earnings.md): Quanto de juro adicional de parcelamento foi cobrado do comprador num período e quanto disso ficou com você depois do rateio por comissão. São dois números diferentes.
- [Estados da Assinatura](https://docs.cakto.com.br/api-reference/subscriptions/states.md): Estados externos mínimos e transições suportadas
- [Listar Assinaturas](https://docs.cakto.com.br/api-reference/subscriptions/list.md): Consulte as assinaturas da sua conta e acompanhe seu status, método de pagamento e situação atual.
- [Recuperar uma Assinatura](https://docs.cakto.com.br/api-reference/subscriptions/retrieve.md): Consulte os detalhes completos de uma assinatura específica pelo ID.
- [Criar Assinatura](https://docs.cakto.com.br/api-reference/subscriptions/create.md): Cria assinatura a partir de um pedido pai
- [Alterar Método de Pagamento](https://docs.cakto.com.br/api-reference/subscriptions/change-payment-method.md): Altera o método de pagamento da assinatura
- [Cancelar Assinatura](https://docs.cakto.com.br/api-reference/subscriptions/cancel.md): Encerre definitivamente uma assinatura e suas cobranças futuras.
- [Atualização via PUT (não suportado)](https://docs.cakto.com.br/api-reference/subscriptions/update.md): PUT e DELETE não são suportados para assinaturas — use as ações dedicadas.
- [Exportar Assinaturas (XLSX)](https://docs.cakto.com.br/api-reference/subscriptions/export-xlsx.md): Baixe a base completa de assinaturas em Excel para análises e relatórios.
- [Exportar Assinaturas (CSV)](https://docs.cakto.com.br/api-reference/subscriptions/export-csv.md): Baixe a base completa de assinaturas em CSV para importação em sistemas e automações.
- [Assinaturas Perdidas](https://docs.cakto.com.br/api-reference/subscriptions/churn.md): Acompanhe cancelamentos e assinaturas inativas para identificar padrões de perda, medir o impacto financeiro e tomar decisões que melhorem a retenção.
- [Listar Ciclos de Cobrança](https://docs.cakto.com.br/api-reference/subscriptions/billing-cycles.md): Acompanhe o histórico completo de cobranças de uma assinatura. Entenda o que foi pago, o que está pendente e o padrão de inadimplência ao longo do tempo.
- [Obter Ciclo de Cobrança](https://docs.cakto.com.br/api-reference/subscriptions/billing-cycle-retrieve.md): Consulte os detalhes completos de um ciclo de cobrança específico, incluindo todas as tentativas de pagamento.
- [Listar Tentativas de Cobrança](https://docs.cakto.com.br/api-reference/subscriptions/billing-cycle-attempts.md): Analise as tentativas de cobrança de um ciclo específico. Entenda por que um pagamento falhou e quando cada tentativa ocorreu.

## OpenAPI Specs

- [openapi](https://api.cakto.com.br/api/baas/openapi.json)
- [schema](/schema.yaml)

## Optional

- [Painel Cakto](https://app.cakto.com.br)
- [Suporte Cakto](mailto:infoprodutores@cakto.com.br)


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