
Checkout Sessions API
Crie sessões de checkout programaticamente.
Preview Checkout
Calcule preços e impostos antes de criar uma sessão.
Payment Methods
Métodos de pagamento e configurações compatíveis.
Integration Guide
Guia passo a passo para integrar o checkout.
Os links de checkout gerados pela Checkout Sessions API não podem ser reutilizados. Eles expiram após 24 horas ou após 15 minutos se
confirm: true estiver definido. Gere uma nova sessão para cada cliente e cada tentativa de pagamento.Adaptive Currency
Adaptive Currency permite que os clientes paguem na moeda local de sua preferência, aumentando a confiança e as taxas de conversão. Quando ativado, os clientes veem um seletor de moedas no checkout. O preço é convertido para a moeda escolhida usando taxas de câmbio atualizadas. Se o produto tiver Purchasing Power Parity ativado, o preço ajustado por PPP será convertido em vez do preço-base. Se Charm Pricing estiver ativado, o valor convertido será arredondado para um final simples, como 49,99.
Adaptive Currency
Moedas compatíveis, tarifas de conversão e gerenciamento de reembolsos.
Checkout em vários idiomas
O checkout é compatível com 22 idiomas. Os clientes podem trocar de idioma diretamente na página, e o texto da interface, os rótulos e as mensagens do sistema são localizados.
Idiomas compatíveis
Para forçar um idioma específico, defina
customization.force_language ao criar uma sessão de checkout. Consulte a Checkout Sessions API para obter mais informações.
Cálculo automático de impostos
Os impostos são calculados automaticamente com base no local de cobrança do cliente, garantindo conformidade com os requisitos de GST, VAT e impostos sobre vendas. As regras fiscais são aplicadas com base no país e na região do cliente, quando aplicável. O valor do imposto é atualizado automaticamente quando o cliente altera o país ou atualiza o endereço. O detalhamento final dos impostos é exibido claramente antes do pagamento.Suporte a Business Tax ID
Para transações B2B, o checkout permite que os clientes insiram o Business Tax ID (por exemplo, o número de VAT ou GST). Quando inserido, o ID fiscal é validado em tempo real, e as isenções fiscais aplicáveis ou as regras de reverse charge são aplicadas automaticamente.
Códigos de desconto
Os clientes podem aplicar códigos de desconto ou promocionais que você criou no dashboard. O desconto é validado instantaneamente e o preço atualizado é exibido. Quando Purchasing Power Parity está ativado em um produto, o desconto é aplicado ao preço ajustado por PPP, não ao preço-base.
discount_codes aceita uma matriz de até 20 códigos, aplicados em ordem. O campo singular discount_code está obsoleto, mas continua funcionando para compatibilidade retroativa.Discount Codes
Crie e gerencie códigos de desconto.
Validate Discount by Code
Consulte e valide descontos usando nomes de códigos.
Coleta inteligente de endereços
O checkout é compatível com a inserção flexível de endereços para equilibrar velocidade, precisão e cobertura global.Opções
Modo de endereço mínimo
Para obter a máxima conversão, ative a coleta mínima de endereço para reduzir o atrito no checkout. Quandominimal_address estiver definido como true, o checkout coletará apenas:
- País — sempre obrigatório para determinar os impostos
- CEP — apenas nas regiões onde for necessário para calcular impostos sobre vendas, VAT ou GST

A coleta completa de endereço é o padrão. Ative
minimal_address para produtos digitais e fluxos SaaS nos quais os dados completos de cobrança não são necessários.Coleta de número de telefone
Controle se o campo de número de telefone aparece no checkout e se ele é obrigatório.Campos personalizados
Colete informações adicionais dos clientes durante o checkout definindo campos de formulário personalizados. Isso é útil para coletar o nome da empresa, o tamanho da equipe, a origem da indicação ou quaisquer outros dados específicos da empresa.Tipos de campos disponíveis
Exemplo
As respostas dos clientes são incluídas automaticamente nos payloads de webhook (
payment.succeeded, subscription.active) e nas respostas da API por meio da matriz custom_field_responses. Você pode definir até 5 campos personalizados por sessão de checkout.Custom Fields Guide
Configuração de campos personalizados e acesso às respostas.
Aceitação da política de privacidade e dos termos
Para garantir transparência jurídica e de conformidade:- Os links da Privacy Policy e dos Buyer Terms são exibidos claramente no checkout
- Os clientes confirmam explicitamente esses documentos antes de concluir o pagamento
Isso ajuda a atender aos requisitos globais de proteção ao consumidor e privacidade de dados, incluindo a conformidade com o GDPR.
Coleções de produtos
As coleções de produtos proporcionam uma experiência de checkout unificada na qual os clientes visualizam e selecionam vários produtos relacionados (por exemplo, planos Starter, Pro e Enterprise) em um único checkout. Ao usar uma coleção, todos os produtos ativos nela são exibidos. O primeiro produto é pré-selecionado, e os clientes podem comparar as opções antes de escolher.Product Collections
Crie e gerencie coleções de produtos.
Configuração da sessão de checkout
Controle o comportamento do checkout usando a Checkout Sessions API:Após o pagamento, os clientes são redirecionados para o seu
return_url, com parâmetros de consulta adicionados automaticamente — incluindo payment_id ou subscription_id, status, email e license_key, quando aplicável. Consulte o guia Checkout Sessions para ver a lista completa.Checkout Sessions API
Referência completa da API para sessões de checkout.
Checkout Integration Guide
Guia passo a passo para integrar o checkout.
Personalização do tema
Personalize a aparência da página de checkout para combinar com a sua marca usando o parâmetrocustomization.theme_config. Configure cores, fontes, raio da borda e texto do botão para os modos claro e escuro.
Esta seção aborda a API do lado do servidor, que usa nomes de propriedades como bg_primary. Um tema definido na sessão se aplica ao checkout hospedado, em sobreposição e inline. A opção themeConfig do lado do cliente do Checkout SDK, que usa nomes de propriedades como bgPrimary, está obsoleta. Consulte Overlay Checkout.

Design & Theme Customization
Configure temas visualmente pelo dashboard com temas predefinidos, tipografia, cores e visualização em tempo real.
Opções de configuração do tema
Configuração de cores (modo claro/escuro)
Cada modo é compatível com estas propriedades de cor:Todos os campos de cor aceitam formatos de cor CSS padrão:
- Hexadecimal:
#fff,#ffffff,#ffffffff - RGB/RGBA:
rgb(255, 255, 255),rgba(255, 255, 255, 0.5) - HSL/HSLA:
hsl(120, 100%, 50%),hsla(120, 100%, 50%, 0.5) - Cores nomeadas:
red,blue,transparent