Visão Geral
O checkout inline permite que você crie experiências de checkout totalmente integradas que se misturam perfeitamente com seu site ou aplicativo. Ao contrário do checkout em sobreposição, que se abre como um modal sobre sua página, o checkout inline incorpora o formulário de pagamento diretamente no layout da sua página. Usando o checkout inline, você pode:- Criar experiências de checkout que estão totalmente integradas ao seu aplicativo ou site
- Permitir que o Dodo Payments capture com segurança as informações do cliente e de pagamento em um quadro de checkout otimizado
- Exibir itens, totais e outras informações do Dodo Payments em sua página
- Usar métodos e eventos da SDK para construir experiências de checkout avançadas

Como Funciona
O checkout inline funciona incorporando um quadro seguro do Dodo Payments em seu site ou aplicativo. O quadro de checkout lida com a coleta de informações do cliente e a captura de detalhes de pagamento. Sua página exibe a lista de itens, totais e opções para alterar o que está no checkout. A SDK permite que sua página e o quadro de checkout interajam entre si. O Dodo Payments cria automaticamente uma assinatura quando um checkout é concluído, pronto para você provisionar.O frame de checkout embutido lida com todas as informações de pagamento sensíveis de forma segura, garantindo conformidade PCI sem certificação adicional do seu lado.
O Que Faz um Bom Checkout Inline?
É importante que os clientes saibam de quem estão comprando, o que estão comprando e quanto estão pagando. Para construir um checkout inline que seja compatível e otimizado para conversão, sua implementação deve incluir:
- Informações recorrentes: Se for recorrente, com que frequência ocorre e o total a ser pago na renovação. Se for um teste, quanto tempo dura o teste.
- Descrições dos itens: Uma descrição do que está sendo comprado.
- Totais da transação: Totais da transação, incluindo subtotal, total de impostos e total geral. Certifique-se de incluir a moeda também.
- Rodapé do Dodo Payments: O quadro completo do checkout inline, incluindo o rodapé do checkout que contém informações sobre o Dodo Payments, nossos termos de venda e nossa política de privacidade.
- Política de reembolso: Um link para sua política de reembolso, se for diferente da política padrão de reembolso do Dodo Payments.
Jornada do Cliente
O fluxo de checkout é determinado pela configuração da sua sessão de checkout. Dependendo de como você configura a sessão de checkout, os clientes experimentarão um checkout que pode apresentar todas as informações em uma única página ou em várias etapas.Customer opens checkout
Você pode abrir o checkout embutido passando itens ou uma transação existente. Use o SDK para mostrar e atualizar informações na página e métodos do SDK para atualizar itens com base na interação do cliente.

Customer enters their details
O checkout inline primeiro pede aos clientes que insiram seu endereço de e-mail, selecionem seu país e (quando necessário) insiram seu CEP ou código postal. Esta etapa coleta todas as informações necessárias para determinar impostos e opções de pagamento disponíveis.Você pode preencher automaticamente os detalhes do cliente e apresentar endereços salvos para agilizar a experiência.
Customer selects payment method
Após inserir seus dados, os clientes são apresentados com os métodos de pagamento disponíveis e o formulário de pagamento. As opções podem incluir cartão de crédito ou débito, PayPal, Apple Pay, Google Pay e outros métodos de pagamento locais com base em sua localização.Exiba métodos de pagamento salvos, se disponíveis, para acelerar o checkout.

Checkout completed
O Dodo Payments direciona cada pagamento para o melhor adquirente para aquela venda, garantindo a melhor chance possível de sucesso. Os clientes entram em um fluxo de sucesso que você pode construir.

Começo Rápido
Comece com o Checkout Inline da Dodo Payments em apenas algumas linhas de código:Guia de Integração Passo a Passo
Initialize the SDK for Inline Display
Inicialize o SDK e especifique
displayType: 'inline'. Você também deve escutar o evento checkout.breakdown para atualizar sua interface com cálculos em tempo real de impostos e totais.Create a Container Element
Adicione um elemento ao seu HTML onde o quadro de checkout será injetado:
Open the Checkout
Chame
DodoPayments.Checkout.open() com o checkoutUrl e o elementId do seu contêiner:Test Your Integration
- Inicie seu servidor de desenvolvimento:
- Teste o fluxo de checkout:
- Insira seu e-mail e detalhes de endereço no quadro inline.
- Verifique se seu resumo de pedido personalizado é atualizado em tempo real.
- Teste o fluxo de pagamento usando credenciais de teste.
- Confirme se os redirecionamentos funcionam corretamente.
Você deve ver eventos
checkout.breakdown registrados no console do navegador se você adicionou um log no callback onEvent.Exemplo Completo em React
Este exemplo demonstra como implementar um resumo de pedido customizado junto ao checkout embutido, mantendo-os sincronizados usando o eventocheckout.breakdown.
Referência da API
Configuração
Opções de Inicialização
| Opção | Tipo | Obrigatório | Descrição |
|---|---|---|---|
mode | "test" | "live" | Sim | Modo de ambiente. |
displayType | "inline" | "overlay" | Sim | Deve ser definido como "inline" para incorporar o checkout. |
onEvent | function | Sim | Função de callback para lidar com eventos do checkout. |
Opções de Checkout
| Opção | Tipo | Obrigatório | Descrição |
|---|---|---|---|
checkoutUrl | string | Sim | URL da sessão de checkout. |
elementId | string | Sim | O id do elemento DOM onde o checkout deve ser renderizado. |
options.showTimer | boolean | Não | Mostrar ou ocultar o cronômetro do checkout. Padrão é true. Quando desativado, você receberá o evento checkout.link_expired quando a sessão expirar. |
options.showSecurityBadge | boolean | Não | Mostrar ou ocultar o selo de segurança. Padrão é true. |
options.payButtonText | string | Não | Texto personalizado para exibir no botão de pagamento. |
options.fontSize | FontSize | Não | Tamanho global da fonte para o checkout. |
options.fontWeight | FontWeight | Não | Peso global da fonte para o checkout. |
Métodos
Abrir Checkout
Abre o quadro de checkout no contêiner especificado.Fechar Checkout
Remove programaticamente o quadro de checkout e limpa os listeners de eventos.Verificar Status
Retorna se o quadro de checkout está atualmente injetado.Eventos
O SDK fornece eventos em tempo real através do callbackonEvent. Para checkout embutido, checkout.breakdown é particularmente útil para sincronizar sua UI.
| Tipo de Evento | Descrição |
|---|---|
checkout.opened | Quadro de checkout foi carregado. |
checkout.form_ready | Formulário de checkout está pronto para receber entrada do usuário. Útil para ocultar estados de carregamento e mostrar a UI de checkout. |
checkout.breakdown | Disparado quando preços, impostos ou descontos são atualizados. |
checkout.customer_details_submitted | Detalhes do cliente foram enviados. |
checkout.pay_button_clicked | Disparado quando o cliente clica no botão de pagamento. Útil para análises e rastreamento de funis de conversão. |
checkout.redirect | O checkout realizará um redirecionamento (por exemplo, para uma página de banco). |
checkout.error | Ocorreu um erro durante o checkout. |
checkout.link_expired | Disparado quando a sessão de checkout expira. Apenas recebido quando showTimer está configurado para false. |
Dados de Detalhamento do Checkout
O eventocheckout.breakdown fornece os seguintes dados:
Compreendendo o Evento de Detalhamento
O eventocheckout.breakdown é a principal forma de manter a UI do seu aplicativo em sincronia com o estado do checkout do Dodo Payments.
Quando ocorre:
- Na inicialização: Imediatamente após o quadro de checkout ser carregado e pronto.
- Na mudança de endereço: Sempre que o cliente seleciona um país ou insere um código postal que resulta em recalcular imposto.
| Campo | Descrição |
|---|---|
subTotal | A soma de todos os itens de linha na sessão antes de quaisquer descontos ou impostos serem aplicados. |
discount | O valor total de todos os descontos aplicados. |
tax | O valor do imposto calculado. No modo inline, isso atualiza dinamicamente conforme o usuário interage com os campos de endereço. |
total | O resultado matemático de subTotal - discount + tax na moeda base da sessão. |
currency | O código da moeda ISO (por exemplo, "USD") para o subtotal padrão, valores de desconto e impostos. |
finalTotal | O valor real cobrado ao cliente. Isso pode incluir ajustes adicionais de câmbio ou tarifas de método de pagamento local que não fazem parte da divisão básica de preços. |
finalTotalCurrency | A moeda na qual o cliente está realmente pagando. Isso pode diferir de currency se a paridade de poder de compra ou conversão de moeda local estiver ativa. |
- Formatação de Moeda: Os preços são sempre retornados como números inteiros na menor unidade de moeda (por exemplo, centavos para USD, ienes para JPY). Para exibi-los, divida por 100 (ou a potência de 10 apropriada) ou use uma biblioteca de formatação como
Intl.NumberFormat. - Tratamento de Estados Iniciais: Quando o checkout carrega pela primeira vez,
taxediscountpodem ser0ounullaté que o usuário forneça suas informações de cobrança ou aplique um código. Sua UI deve lidar com esses estados graciosamente (por exemplo, mostrando um traço—ou ocultando a linha). - O “Total Final” vs “Total”: Enquanto
totalfornece o cálculo do preço padrão,finalTotalé a fonte da verdade para a transação. SefinalTotalestiver presente, ele reflete exatamente o que será cobrado no cartão do cliente, incluindo quaisquer ajustes dinâmicos. - Feedback em Tempo Real: Use o campo
taxpara mostrar aos usuários que os impostos estão sendo calculados em tempo real. Isso proporciona uma sensação “ao vivo” à sua página de checkout e reduz o atrito durante a etapa de entrada de endereço.
Opções de Implementação
Instalação via Gerenciador de Pacotes
Instale via npm, yarn ou pnpm conforme mostrado no Guia de Integração Passo a Passo.Implementação via CDN
Para integração rápida sem uma etapa de build, você pode usar nosso CDN:Atualizar Método de Pagamento
O checkout embutido suporta atualizações de método de pagamento para assinaturas. Quando um cliente precisa atualizar seu método de pagamento — seja para uma assinatura ativa ou para reativar uma assinatura em espera — você pode renderizar o fluxo de atualização diretamente no layout da sua página.Como Funciona
- Chame a API de Atualização de Método de Pagamento para obter um
payment_link:
- Passe o
payment_linkretornado como ocheckoutUrlpara abrir o checkout embutido:
Para Assinaturas em Espera
Ao atualizar o método de pagamento de uma assinatura em statuson_hold, o Dodo Payments cria automaticamente uma cobrança para quaisquer dívidas remanescentes. Monitore os webhooks payment.succeeded e subscription.active para confirmar a reativação.
Tratamento de Erros
O SDK fornece informações detalhadas sobre erros através do sistema de eventos. Sempre implemente tratamento adequado de erros em seu callbackonEvent:
Melhores Práticas
- Design Responsivo: Certifique-se de que seu elemento contêiner tenha largura e altura suficientes. O iframe normalmente se expande para preencher seu contêiner.
- Sincronização: Use o evento
checkout.breakdownpara manter seu resumo de pedido personalizado ou tabelas de preços em sincronia com o que o usuário vê no frame de checkout. - Estados de Esqueleto: Mostre um indicador de carregamento em seu contêiner até que o evento
checkout.openedseja disparado. - Limpeza: Chame
DodoPayments.Checkout.close()quando seu componente desmontar para limpar o iframe e os listeners de eventos.
Para implementações em modo escuro, é recomendado usar
#0d0d0d como a cor de fundo para uma integração visual ótima com o frame de checkout embutido.Validação de Status de Pagamento
Por Que a Validação no Lado do Servidor é Essencial
Embora os eventos de checkout embutido forneçam feedback em tempo real, eles não devem ser sua única fonte de verdade para o status de pagamento. Problemas de rede, falhas no navegador ou usuários fechando a página podem fazer com que eventos sejam perdidos. Para garantir validação de pagamento confiável:- Seu servidor deve ouvir eventos de webhook - Dodo Payments envia webhooks para alterações de status de pagamento
- Implemente um mecanismo de polling - Sua interface deve verificar seu servidor por atualizações de status
- Combine ambas as abordagens - Use webhooks como fonte principal e polling como um retaguarda
Arquitetura Recomendada
Passos de Implementação
1. Ouça eventos de checkout - Quando o usuário clica em pagar, comece a preparar a verificação do status:payment.succeeded ou payment.failed. Consulte nossa documentação de Webhooks para detalhes.
Solução de Problemas
Checkout frame is not appearing
Checkout frame is not appearing
- Verifique se
elementIdcoincide com oidde umdivque realmente existe no DOM. - Certifique-se de que
displayType: 'inline'foi passado paraInitialize. - Verifique se
checkoutUrlé válido.
Taxes are not updating in my UI
Taxes are not updating in my UI
- Certifique-se de que está ouvindo o evento
checkout.breakdown. - Impostos são calculados apenas depois que o usuário insere um país e código postal válidos no quadro de checkout.
Ativando Carteiras Digitais
Para informações detalhadas sobre configuração do Apple Pay, Google Pay e outras carteiras digitais, consulte a página Carteiras Digitais.Configuração Rápida para Apple Pay
Download domain association file
Request activation
Envie um e-mail para support@dodopayments.com com a URL do seu domínio de produção e solicite a ativação do Apple Pay.
Suporte a Navegadores
O SDK de Checkout do Dodo Payments suporta os seguintes navegadores:- Chrome (mais recente)
- Firefox (mais recente)
- Safari (mais recente)
- Edge (mais recente)
- IE11+
Checkout Embutido vs Overlay
Escolha o tipo de checkout certo para seu caso de uso:| Recurso | Checkout Embutido | Checkout Overlay |
|---|---|---|
| Profundidade de integração | Totalmente incorporado na página | Modal sobre a página |
| Controle de layout | Controle total | Limitado |
| Branding | Integrado | Separado da página |
| Esforço de implementação | Maior | Menor |
| Melhor para | Páginas de checkout personalizadas, fluxos de alta conversão | Integração rápida, páginas existentes |
Recursos Relacionados
Overlay Checkout
Use o checkout overlay para integração rápida baseada em modal.
Checkout Sessions API
Crie sessões de checkout para potencializar suas experiências de checkout.
Webhooks
Trate eventos de pagamento no lado do servidor com webhooks.
Integration Guide
Guia completo para integrar Dodo Payments.
