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 inline 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 temporizador do checkout. Padrão para 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 para true. |
options.manualRedirect | boolean | Não | Quando ativado, o checkout não redirecionará automaticamente após a conclusão. Em vez disso, você receberá os eventos checkout.status e checkout.redirect_requested para lidar com o redirecionamento por conta própria. |
options.payButtonText | string | Não | Texto personalizado para exibir no botão de pagamento. |
options.fontSize | FontSize | Não | Tamanho global da fonte do checkout. |
options.fontWeight | FontWeight | Não | Peso global da fonte do checkout. |
Métodos
Abrir Checkout
Abre o quadro de checkout no contêiner especificado.manualRedirect, trate a conclusão do checkout no seu callback onEvent:
Fechar Checkout
Remove programaticamente o quadro de checkout e limpa os ouvintes de eventos.Verificar Status
Retorna se o quadro de checkout está atualmente injetado.Eventos
O SDK fornece eventos em tempo real por meio do callbackonEvent. Para o checkout embutido, o evento checkout.breakdown é particularmente útil para sincronizar sua interface.
| Tipo de evento | Descrição |
|---|---|
checkout.opened | O frame do checkout foi carregado. |
checkout.form_ready | O formulário do checkout está pronto para receber os dados do usuário. Útil para ocultar estados de carregamento e mostrar a interface do checkout. |
checkout.breakdown | Disparado quando preços, impostos ou descontos são atualizados. |
checkout.customer_details_submitted | Os detalhes do cliente foram enviados. |
checkout.pay_button_clicked | Disparado quando o cliente clica no botão de pagamento. Útil para analytics e acompanhamento de funis de conversão. |
checkout.redirect | O checkout realizará um redirecionamento (por exemplo, para uma página bancária). |
checkout.error | Ocorreu um erro durante o checkout. |
checkout.link_expired | Disparado quando a sessão de checkout expira. Só é recebido quando showTimer está definido como false. |
checkout.status | Disparado quando manualRedirect está habilitado. Contém o status do checkout (succeeded, failed ou processing). |
checkout.redirect_requested | Disparado quando manualRedirect está habilitado. Contém a URL para redirecionar o cliente. |
Dados de Quebra do Checkout
O eventocheckout.breakdown fornece os seguintes dados:
Dados do Evento de Status do Checkout
QuandomanualRedirect está habilitado, você recebe o evento checkout.status com os seguintes dados:
Dados do Evento de Redirecionamento do Checkout Solicitado
QuandomanualRedirect está habilitado, você recebe o evento checkout.redirect_requested com os seguintes dados:
Entendendo o Evento de Quebra
O eventocheckout.breakdown é a principal forma de manter a interface da sua aplicação sincronizada com o estado do checkout da Dodo Payments.
Quando ele é disparado:
- Na inicialização: Imediatamente após o quadro de checkout ser carregado e estar pronto.
- Na mudança de endereço: Sempre que o cliente seleciona um país ou insere um código postal que resulta em um recálculo de impostos.
| Campo | Descrição |
|---|---|
subTotal | A soma de todos os itens na sessão antes de qualquer desconto ou imposto ser aplicado. |
discount | O valor total de todos os descontos aplicados. |
tax | O valor calculado de impostos. No modo inline, isso é atualizado dinamicamente à medida que 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 ISO da moeda (por exemplo, "USD") para o subtotal, desconto e valores de impostos padrão. |
finalTotal | O valor real cobrado do cliente. Isso pode incluir ajustes de câmbio adicionais ou taxas de métodos locais que não fazem parte da decomposição básica de preços. |
finalTotalCurrency | A moeda na qual o cliente está realmente pagando. Isso pode diferir de currency se houver paridade do poder de compra ou conversão para moeda local ativa. |
- Formatação de Moeda: Os preços são sempre retornados como inteiros na menor unidade monetária (por exemplo, centavos para USD, ienes para JPY). Para exibi-los, divida por 100 (ou pela potência adequada de 10) 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 informações de cobrança ou aplique um código. Sua interface deve lidar com esses estados de forma elegante (por exemplo, exibindo um traço—ou ocultando a linha). - O “Total Final” vs “Total”: Enquanto
totalfornece o cálculo de preço padrão,finalTotalé a fonte de 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 dá uma sensação “ao vivo” à sua página de checkout e reduz atritos durante a etapa de preenchimento do 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 CDN
Para uma integração rápida sem uma etapa de build, você pode usar nosso CDN:Atualizar Método de Pagamento
O inline checkout 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 dentro do layout da sua página.Como Funciona
- Chame a Update Payment Method API para obter um
payment_link:
- Passe o
payment_linkretornado como ocheckoutUrlpara abrir o inline checkout:
Para Assinaturas em Espera
Ao atualizar o método de pagamento de uma assinatura no statuson_hold, a Dodo Payments cria automaticamente uma cobrança pelos valores pendentes. Monitore os webhooks payment.succeeded e subscription.active para confirmar a reativação.
Tratamento de Erros
O SDK fornece informações detalhadas sobre erros por meio do sistema de eventos. Sempre implemente um tratamento adequado de erros no seu callbackonEvent:
Melhores Práticas
- Design Responsivo: Garanta que o elemento contêiner tenha largura e altura suficientes. O iframe normalmente se expandirá para preencher seu contêiner.
- Sincronização: Use o evento
checkout.breakdownpara manter seu resumo de pedido personalizado ou tabelas de preços sincronizados com o que o usuário vê no frame do checkout. - Estados de Esqueleto: Exiba um indicador de carregamento no seu contêiner até que o evento
checkout.openedseja disparado. - Limpeza: Chame
DodoPayments.Checkout.close()quando seu componente for desmontado para limpar o iframe e os ouvintes de eventos.
Para implementações em modo escuro, é recomendado usar
#0d0d0d como cor de fundo para garantir uma integração visual otimizada com o frame do inline checkout.Validação do Status do Pagamento
Por que a Validação no Lado do Servidor é Essencial
Embora eventos do inline checkout comocheckout.status forneçam feedback em tempo real, eles não devem ser sua única fonte de verdade sobre o status do pagamento. Problemas de rede, travamentos do navegador ou usuários fechando a página podem fazer com que eventos sejam perdidos. Para garantir uma validação confiável do pagamento:
- Seu servidor deve escutar eventos de webhook - A Dodo Payments envia webhooks para alterações no status do pagamento
- Implemente um mecanismo de polling - Seu frontend deve consultar seu servidor em busca de atualizações de status
- Combine ambas as abordagens - Use webhooks como fonte principal e polling como alternativa
Arquitetura Recomendada
Etapas de Implementação
1. Escute eventos do checkout - Quando o usuário clicar em pagar, comece a se preparar para verificar o status:payment.succeeded ou payment.failed. Veja nossa documentação de Webhooks para mais detalhes.
Tratando Redirecionamentos (3DS, Google Pay, UPI)
Ao usarmanualRedirect: true, certos métodos de pagamento exigem redirecionar o usuário para fora da sua página para autenticação:
- 3D Secure (3DS) - Autenticação do cartão
- Google Pay - Autenticação da carteira em alguns fluxos
- UPI - Redirecionamentos do método de pagamento indiano
checkout.redirect_requested. Redirecione o usuário para a URL fornecida:
- Verifique se o usuário está retornando de um redirecionamento (por exemplo, via
sessionStorage) - Comece a consultar seu servidor em busca do status confirmado do pagamento
- Exiba um estado “Verificando pagamento…” enquanto realiza o polling
- Mostre a interface de sucesso/falha com base no status confirmado pelo servidor
Solução de Problemas
Checkout frame is not appearing
Checkout frame is not appearing
- Verifique se
elementIdcorresponde aoidde umdivque realmente existe no DOM. - Certifique-se de que
displayType: 'inline'foi passado paraInitialize. - Verifique se o
checkoutUrlé válido.
Taxes are not updating in my UI
Taxes are not updating in my UI
- Certifique-se de que você está escutando o evento
checkout.breakdown. - Os impostos só são calculados depois que o usuário insere um país e um código postal válidos no frame do checkout.
Habilitando Carteiras Digitais
Para obter informações detalhadas sobre como configurar o Apple Pay, Google Pay e outras carteiras digitais, consulte a página Digital Wallets.Configuração Rápida para Apple Pay
Download domain association file
Faça o download do arquivo de associação de domínio do Apple Pay.
Request activation
Envie um e-mail para support@dodopayments.com com a URL do seu domínio em produção e solicite a ativação do Apple Pay.
Compatibilidade com Navegadores
O SDK Dodo Payments Checkout oferece suporte aos seguintes navegadores:- Chrome (última versão)
- Firefox (última versão)
- Safari (última versão)
- Edge (última versão)
- IE11+
Inline vs Overlay Checkout
Escolha o tipo de checkout certo para o seu caso de uso:| Recurso | Inline Checkout | Overlay Checkout |
|---|---|---|
| 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 |
| Ideal para | Páginas de checkout personalizadas, fluxos com alta conversão | Integração rápida, páginas existentes |
Recursos Relacionados
Overlay Checkout
Use o overlay checkout para uma integração rápida baseada em modal.
Checkout Sessions API
Crie sessões de checkout para alimentar suas experiências de checkout.
Webhooks
Trate eventos de pagamento no lado do servidor com webhooks.
Integration Guide
Guia completo para integrar a Dodo Payments.
