Pular para o conteúdo principal

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
Imagem de Capa do Checkout Embutido

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:
Exemplo de checkout embutido com elementos obrigatórios rotulados
  1. 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.
  2. Descrições dos itens: Uma descrição do que está sendo comprado.
  3. Totais da transação: Totais da transação, incluindo subtotal, total de impostos e total geral. Certifique-se de incluir a moeda também.
  4. 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.
  5. 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.
Sempre exiba o frame completo do checkout embutido, incluindo o rodapé. Remover ou ocultar informações legais viola os requisitos de conformidade.

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.
1

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.Página inicial do checkout com lista de itens e formulário de pagamento
2

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.
3

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.Formulário de métodos de pagamento disponíveis e detalhes do cartão
4

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.Tela de sucesso com check de confirmação
5

Dodo Payments creates subscription

O Dodo Payments cria automaticamente uma assinatura para o cliente, pronta para você provisionar. O método de pagamento que o cliente usou é mantido em arquivo para renovações ou alterações de assinatura.Assinatura criada com notificação de webhook

Começo Rápido

Comece com o Checkout Inline da Dodo Payments em apenas algumas linhas de código:
import { DodoPayments } from "dodopayments-checkout";

// Initialize the SDK for inline mode
DodoPayments.Initialize({
  mode: "test",
  displayType: "inline",
  onEvent: (event) => {
    console.log("Checkout event:", event);
  },
});

// Open checkout in a specific container
DodoPayments.Checkout.open({
  checkoutUrl: "https://test.dodopayments.com/session/cks_123",
  elementId: "dodo-inline-checkout" // ID of the container element
});
Certifique-se de ter um elemento contêiner com o id correspondente na sua página: <div id="dodo-inline-checkout"></div>.

Guia de Integração Passo a Passo

1

Install the SDK

Instale o SDK de Checkout da Dodo Payments:
npm install dodopayments-checkout
2

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.
import { DodoPayments } from "dodopayments-checkout";

DodoPayments.Initialize({
  mode: "test",
  displayType: "inline",
  onEvent: (event) => {
    if (event.event_type === "checkout.breakdown") {
      const breakdown = event.data?.message;
      // Update your UI with breakdown.subTotal, breakdown.tax, breakdown.total, etc.
    }
  },
});
3

Create a Container Element

Adicione um elemento ao seu HTML onde o quadro de checkout será injetado:
<div id="dodo-inline-checkout"></div>
4

Open the Checkout

Chame DodoPayments.Checkout.open() com o checkoutUrl e o elementId do seu contêiner:
DodoPayments.Checkout.open({
  checkoutUrl: "https://test.dodopayments.com/session/cks_123",
  elementId: "dodo-inline-checkout"
});
5

Test Your Integration

  1. Inicie seu servidor de desenvolvimento:
npm run dev
  1. 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.
6

Go Live

Quando você estiver pronto para produção:
  1. Altere o modo para 'live':
DodoPayments.Initialize({
  mode: "live",
  displayType: "inline",
  onEvent: (event) => {
    // Handle events
  }
});
  1. Atualize suas URLs de checkout para usar sessões de checkout ao vivo do seu backend.
  2. Teste o fluxo completo em produção.

Exemplo Completo em React

Este exemplo demonstra como implementar um resumo de pedido customizado junto ao checkout embutido, mantendo-os sincronizados usando o evento checkout.breakdown.
"use client";

import { useEffect, useState } from 'react';
import { DodoPayments, CheckoutBreakdownData } from 'dodopayments-checkout';

export default function CheckoutPage() {
  const [breakdown, setBreakdown] = useState<Partial<CheckoutBreakdownData>>({});

  useEffect(() => {
    // 1. Initialize the SDK
    DodoPayments.Initialize({
      mode: 'test',
      displayType: 'inline',
      onEvent: (event) => {
        // 2. Listen for the 'checkout.breakdown' event
        if (event.event_type === "checkout.breakdown") {
          const message = event.data?.message as CheckoutBreakdownData;
          if (message) setBreakdown(message);
        }
      }
    });

    // 3. Open the checkout in the specified container
    DodoPayments.Checkout.open({
      checkoutUrl: 'https://test.dodopayments.com/session/cks_123',
      elementId: 'dodo-inline-checkout'
    });

    return () => DodoPayments.Checkout.close();
  }, []);

  const format = (amt: number | null | undefined, curr: string | null | undefined) => 
    amt != null && curr ? `${curr} ${(amt/100).toFixed(2)}` : '0.00';

  const currency = breakdown.currency ?? breakdown.finalTotalCurrency ?? '';

  return (
    <div className="flex flex-col md:flex-row min-h-screen">
      {/* Left Side - Checkout Form */}
      <div className="w-full md:w-1/2 flex items-center">
        <div id="dodo-inline-checkout" className='w-full' />
      </div>

      {/* Right Side - Custom Order Summary */}
      <div className="w-full md:w-1/2 p-8 bg-gray-50">
        <h2 className="text-2xl font-bold mb-4">Order Summary</h2>
        <div className="space-y-2">
          {breakdown.subTotal && (
            <div className="flex justify-between">
              <span>Subtotal</span>
              <span>{format(breakdown.subTotal, currency)}</span>
            </div>
          )}
          {breakdown.discount && (
            <div className="flex justify-between">
              <span>Discount</span>
              <span>{format(breakdown.discount, currency)}</span>
            </div>
          )}
          {breakdown.tax != null && (
            <div className="flex justify-between">
              <span>Tax</span>
              <span>{format(breakdown.tax, currency)}</span>
            </div>
          )}
          <hr />
          {(breakdown.finalTotal ?? breakdown.total) && (
            <div className="flex justify-between font-bold text-xl">
              <span>Total</span>
              <span>{format(breakdown.finalTotal ?? breakdown.total, breakdown.finalTotalCurrency ?? currency)}</span>
            </div>
          )}
        </div>
      </div>
    </div>
  );
}

Referência da API

Configuração

Opções de Inicialização

interface InitializeOptions {
  mode: "test" | "live";
  displayType: "inline"; // Required for inline checkout
  onEvent: (event: CheckoutEvent) => void;
}
OpçãoTipoObrigatórioDescrição
mode"test" | "live"SimModo de ambiente.
displayType"inline" | "overlay"SimDeve ser definido como "inline" para incorporar o checkout.
onEventfunctionSimFunção de callback para lidar com eventos do checkout.

Opções de Checkout

export type FontSize = "xs" | "sm" | "md" | "lg" | "xl" | "2xl";
export type FontWeight = "normal" | "medium" | "bold" | "extraBold";

interface CheckoutOptions {
  checkoutUrl: string;
  elementId: string; // Required for inline checkout
  options?: {
    showTimer?: boolean;
    showSecurityBadge?: boolean;
    payButtonText?: string;
    fontSize?: FontSize;
    fontWeight?: FontWeight;
  };
}
OpçãoTipoObrigatórioDescrição
checkoutUrlstringSimURL da sessão de checkout.
elementIdstringSimO id do elemento DOM onde o checkout deve ser renderizado.
options.showTimerbooleanNãoMostrar 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.showSecurityBadgebooleanNãoMostrar ou ocultar o selo de segurança. Padrão é true.
options.payButtonTextstringNãoTexto personalizado para exibir no botão de pagamento.
options.fontSizeFontSizeNãoTamanho global da fonte para o checkout.
options.fontWeightFontWeightNãoPeso global da fonte para o checkout.

Métodos

Abrir Checkout

Abre o quadro de checkout no contêiner especificado.
DodoPayments.Checkout.open({
  checkoutUrl: "https://test.dodopayments.com/session/cks_123",
  elementId: "dodo-inline-checkout"
});
Você também pode passar opções adicionais para personalizar o comportamento do checkout:
DodoPayments.Checkout.open({
  checkoutUrl: "https://test.dodopayments.com/session/cks_123",
  elementId: "dodo-inline-checkout",
  options: {
    showTimer: false,
    showSecurityBadge: false,
    payButtonText: "Pay Now",
  },
});

Fechar Checkout

Remove programaticamente o quadro de checkout e limpa os listeners de eventos.
DodoPayments.Checkout.close();

Verificar Status

Retorna se o quadro de checkout está atualmente injetado.
const isOpen = DodoPayments.Checkout.isOpen();
// Returns: boolean

Eventos

O SDK fornece eventos em tempo real através do callback onEvent. Para checkout embutido, checkout.breakdown é particularmente útil para sincronizar sua UI.
Tipo de EventoDescrição
checkout.openedQuadro de checkout foi carregado.
checkout.form_readyFormulário de checkout está pronto para receber entrada do usuário. Útil para ocultar estados de carregamento e mostrar a UI de checkout.
checkout.breakdownDisparado quando preços, impostos ou descontos são atualizados.
checkout.customer_details_submittedDetalhes do cliente foram enviados.
checkout.pay_button_clickedDisparado quando o cliente clica no botão de pagamento. Útil para análises e rastreamento de funis de conversão.
checkout.redirectO checkout realizará um redirecionamento (por exemplo, para uma página de banco).
checkout.errorOcorreu um erro durante o checkout.
checkout.link_expiredDisparado quando a sessão de checkout expira. Apenas recebido quando showTimer está configurado para false.

Dados de Detalhamento do Checkout

O evento checkout.breakdown fornece os seguintes dados:
interface CheckoutBreakdownData {
  subTotal?: number;          // Amount in cents
  discount?: number;         // Amount in cents
  tax?: number;              // Amount in cents
  total?: number;            // Amount in cents
  currency?: string;         // e.g., "USD"
  finalTotal?: number;       // Final amount including adjustments
  finalTotalCurrency?: string; // Currency for the final total
}

Compreendendo o Evento de Detalhamento

O evento checkout.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.
Detalhes dos Campos:
CampoDescrição
subTotalA soma de todos os itens de linha na sessão antes de quaisquer descontos ou impostos serem aplicados.
discountO valor total de todos os descontos aplicados.
taxO valor do imposto calculado. No modo inline, isso atualiza dinamicamente conforme o usuário interage com os campos de endereço.
totalO resultado matemático de subTotal - discount + tax na moeda base da sessão.
currencyO código da moeda ISO (por exemplo, "USD") para o subtotal padrão, valores de desconto e impostos.
finalTotalO 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.
finalTotalCurrencyA 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.
Dicas de Integração Chave:
  1. 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.
  2. Tratamento de Estados Iniciais: Quando o checkout carrega pela primeira vez, tax e discount podem ser 0 ou null até 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).
  3. O “Total Final” vs “Total”: Enquanto total fornece o cálculo do preço padrão, finalTotal é a fonte da verdade para a transação. Se finalTotal estiver presente, ele reflete exatamente o que será cobrado no cartão do cliente, incluindo quaisquer ajustes dinâmicos.
  4. Feedback em Tempo Real: Use o campo tax para 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:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Dodo Payments Inline Checkout</title>
    
    <!-- Load DodoPayments -->
    <script src="https://cdn.jsdelivr.net/npm/dodopayments-checkout@latest/dist/index.js"></script>
    <script>
        // Initialize the SDK
        DodoPaymentsCheckout.DodoPayments.Initialize({
            mode: "test",
            displayType: "inline",
            onEvent: (event) => {
                console.log('Checkout event:', event);
            }
        });
    </script>
</head>
<body>
    <div id="dodo-inline-checkout"></div>

    <script>
        // Open the checkout
        DodoPaymentsCheckout.DodoPayments.Checkout.open({
            checkoutUrl: "https://test.dodopayments.com/session/cks_123",
            elementId: "dodo-inline-checkout"
        });
    </script>
</body>
</html>

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

  1. Chame a API de Atualização de Método de Pagamento para obter um payment_link:
const response = await client.subscriptions.updatePaymentMethod('sub_123', {
  type: 'new',
  return_url: 'https://example.com/return'
});
  1. Passe o payment_link retornado como o checkoutUrl para abrir o checkout embutido:
DodoPayments.Checkout.open({
  checkoutUrl: response.payment_link,
  elementId: "dodo-inline-checkout"
});
O quadro embutido renderiza apenas o formulário de coleta de método de pagamento. Os clientes podem inserir novos detalhes do cartão ou selecionar um método de pagamento salvo sem sair da sua página.

Para Assinaturas em Espera

Ao atualizar o método de pagamento de uma assinatura em status on_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.
const response = await client.subscriptions.updatePaymentMethod('sub_123', {
  type: 'new',
  return_url: 'https://example.com/return'
});

if (response.payment_id) {
  // Charge created for remaining dues
  // Open inline checkout for payment collection
  DodoPayments.Checkout.open({
    checkoutUrl: response.payment_link,
    elementId: "dodo-inline-checkout"
  });
}
Você também pode usar um método de pagamento salvo existente, em vez de coletar novos detalhes, passando type: 'existing' com um payment_method_id para a API de Atualização de Método de Pagamento.

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 callback onEvent:
DodoPayments.Initialize({
  mode: "test",
  displayType: "inline",
  onEvent: (event: CheckoutEvent) => {
    if (event.event_type === "checkout.error") {
      console.error("Checkout error:", event.data?.message);
      // Handle error appropriately
    }
  }
});
Sempre trate o evento checkout.error para proporcionar uma boa experiência ao usuário quando problemas ocorrerem.

Melhores Práticas

  1. 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.
  2. Sincronização: Use o evento checkout.breakdown para manter seu resumo de pedido personalizado ou tabelas de preços em sincronia com o que o usuário vê no frame de checkout.
  3. Estados de Esqueleto: Mostre um indicador de carregamento em seu contêiner até que o evento checkout.opened seja disparado.
  4. 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

Não confie apenas nos eventos de checkout embutido para determinar o sucesso ou falha do pagamento. Sempre implemente validação no lado do servidor usando webhooks e/ou polling.

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:
  1. Seu servidor deve ouvir eventos de webhook - Dodo Payments envia webhooks para alterações de status de pagamento
  2. Implemente um mecanismo de polling - Sua interface deve verificar seu servidor por atualizações de status
  3. 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:
onEvent: (event) => {
  if (event.event_type === 'checkout.pay_button_clicked') {
    // Start polling your server for confirmed status
    startPolling();
  }
}
2. Faça polling em seu servidor - Crie um endpoint que verifica seu banco de dados para o status de pagamento (atualizado por webhooks):
// Poll every 2 seconds until status is confirmed
const interval = setInterval(async () => {
  const { status } = await fetch(`/api/payments/${paymentId}/status`).then(r => r.json());
  if (status === 'succeeded' || status === 'failed') {
    clearInterval(interval);
    handlePaymentResult(status);
  }
}, 2000);
3. Trate webhooks no lado do servidor - Atualize seu banco de dados quando o Dodo enviar webhooks payment.succeeded ou payment.failed. Consulte nossa documentação de Webhooks para detalhes.

Solução de Problemas

  • Verifique se elementId coincide com o id de um div que realmente existe no DOM.
  • Certifique-se de que displayType: 'inline' foi passado para Initialize.
  • Verifique se checkoutUrl é válido.
  • 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

1

Download domain association file

2

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.
3

Test after confirmation

Uma vez confirmado, verifique se o Apple Pay aparece no checkout e teste todo o fluxo.
O Apple Pay requer verificação de domínio antes de aparecer em produção. Entre em contato com o suporte antes de lançar se você planeja oferecer 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:
RecursoCheckout EmbutidoCheckout Overlay
Profundidade de integraçãoTotalmente incorporado na páginaModal sobre a página
Controle de layoutControle totalLimitado
BrandingIntegradoSeparado da página
Esforço de implementaçãoMaiorMenor
Melhor paraPáginas de checkout personalizadas, fluxos de alta conversãoIntegração rápida, páginas existentes
Use o checkout embutido quando quiser máximo controle sobre a experiência de checkout e integração de marca. Use o checkout overlay para integração mais rápida com mudanças mínimas em suas 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.
Para mais ajuda, visite nossa comunidade no Discord ou entre em contato com nossa equipe de suporte ao desenvolvedor.
Last modified on April 20, 2026