For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/features/integrations/pagarme.md.
  • Português
  • Integrar Pagar.me

    Crie uma integração de entrada na Clickmax, cole a chave secreta (sk_…) da sua conta Pagar.me e cadastre a URL gerada nos webhooks da Pagar.me, com a autenticação ativada usando o usuário e a senha que a Clickmax mostra. A partir daí, cada evento com e-mail do cliente cria ou atualiza um contato (com a tag pagarme), as cobranças viram vendas na Clickmax e os eventos ficam disponíveis como gatilhos de automação.

    Antes de começar

    • Papel de workspace: Proprietário, Administrador, Editor ou Colaborador. Os papéis Financeiro, Convidado e Atendente não têm acesso a Integrações.
    • Da sua conta Pagar.me você precisa da chave secreta, em Configurações > Chaves de API. Ela começa com sk_ (produção) ou sk_test_ (teste). A chave pública (pk_…) não substitui a chave secreta.
    • A chave pública (pk_…), na mesma tela, é opcional. Sem ela a integração recebe webhooks, registra vendas e dispara gatilhos normalmente, mas o bloco Checkout Pagar.me não consegue vender.
    • A chave secreta é obrigatória para conectar: a Clickmax a usa para identificar o plano das faturas de assinatura, os produtos das cobranças Pix/boleto e dos estornos de assinatura, para registrar chargebacks e para listar seus planos nos gatilhos.

    Passo a passo

    1. Na Clickmax, abra Integrações e selecione o card Pagar.me.
    2. Em outra aba, acesse o painel da Pagar.me e faça login.
    3. Na Pagar.me, vá em Configurações > Chaves de API e clique em Criar chave:
      • Nome da chave: um nome que identifique o uso, como Clickmax.
      • Deixe desmarcada a opção "Utilizo os módulos legados do Magento 2 ou Woocommerce (Mundipagg)".
      • Em Acesso da chave, escolha Personalizado e ative só o escopo Transacional, com Leitura e escrita. Deixe Financeiro e Recebedores desligados: a Clickmax não usa saldo, transferências nem recebedores, e a chave fica com o mínimo de acesso.
      • Confirme com a senha da sua conta Pagar.me e clique em Criar chave.
      • Copie a chave secreta (sk_…) e cole no campo Chave secreta (sk_) da Clickmax.
      • Na mesma tela de Chaves de API, copie também a chave pública (pk_…) e cole no campo Chave pública (pk_). Ela é opcional e só é necessária para vender pelo bloco Checkout Pagar.me nas páginas. As duas chaves precisam ser do mesmo ambiente: sk_test_ com pk_test_, ou sk_ com pk_.
    4. Informe um Apelido para a integração e clique em Criar integração. A Clickmax confere a chave na Pagar.me antes de salvar.
    5. A Clickmax mostra a URL do webhook, o Usuário do webhook (sempre clickmax) e a Senha do webhook. Deixe essa tela aberta.
    6. Na Pagar.me, vá em Configurações > Webhooks > Criar webhook e cole a URL copiada.
    7. Ative Habilitar autenticação. Em Usuário do Webhook cole clickmax e em Senha do Webhook cole a senha mostrada pela Clickmax. Sem a autenticação, a Clickmax recusa todos os webhooks.
    8. Selecione os eventos: order.created, order.paid, order.payment_failed, order.canceled, charge.pending, charge.refunded, chargeback.received, subscription.created, subscription.canceled, invoice.paid e invoice.payment_failed.
    9. Salve o webhook na Pagar.me e clique em Concluir integração na Clickmax.

    O usuário e a senha continuam disponíveis depois: abra a integração em Integrações e copie-os no topo da tela.

    Vender direto nas suas páginas

    Com a chave pública na integração, você pode vender com cartão, Pix e boleto pelo bloco Checkout Pagar.me nas páginas do editor e na etapa Checkout Externo do funil. Além das chaves, a conta Pagar.me precisa ter os meios de pagamento ativos e o domínio das páginas liberado em Configurações > Conta > Domínios; sem o domínio, o pagamento com cartão falha. Veja todos os requisitos em Como vender pela Pagar.me direto na minha página.

    Gatilhos disponíveis

    Cada evento com e-mail do cliente cria ou atualiza um contato com a tag pagarme. Pedidos e faturas pagos marcam o contato como cliente. Eventos sem e-mail do cliente são ignorados.

    Evento na Pagar.meGatilho na ClickmaxQuando dispara
    order.createdPedido criadoUm pedido Pix ou boleto é criado e aguarda pagamento
    order.paidPedido pagoO pedido é pago
    order.payment_failedPagamento do pedido falhouO pagamento do pedido é recusado
    order.canceledPedido canceladoUm pedido que não chegou a ser pago é cancelado
    charge.pendingPix/boleto geradoUm Pix ou boleto é gerado e aguarda pagamento
    charge.refundedCobrança reembolsadaUma cobrança é estornada
    chargeback.receivedChargeback recebidoA Pagar.me recebe um chargeback de uma cobrança
    subscription.createdAssinatura criadaUma assinatura é criada
    subscription.canceledAssinatura canceladaUma assinatura é cancelada
    invoice.paidFatura da assinatura pagaA primeira cobrança ou uma renovação da assinatura é paga
    invoice.payment_failedPagamento da fatura falhouA cobrança de uma fatura da assinatura é recusada

    Detalhes que mudam o comportamento:

    • Pedido criado só dispara para pedidos que ficam aguardando pagamento (Pix e boleto). Uma compra no cartão vai direto para Pedido pago ou Pagamento do pedido falhou.
    • Pix/boleto gerado só dispara para Pix e boleto. Um cartão em análise não dispara esse gatilho.
    • Pedido cancelado não dispara quando o pedido já tinha sido pago e depois foi estornado. Nesse caso quem dispara é Cobrança reembolsada, então a automação roda uma vez só.
    • O estorno de um pedido avulso chega pelo evento order.canceled da Pagar.me. Se ele não estiver selecionado no webhook, o estorno não é registrado nem dispara Cobrança reembolsada.

    Como as vendas são registradas

    • Uma venda por cobrança. Um pedido pago com dois meios de pagamento gera duas vendas; cada renovação de assinatura gera uma venda nova.
    • A mesma venda acompanha a cobrança. Um Pix ou boleto gerado entra como venda pendente e passa a paga quando o pagamento é confirmado. Estorno e chargeback atualizam essa mesma venda, sem criar outra.
    • Pedido com mais de um produto gera uma venda com o valor total da cobrança. Na lista de vendas externas o produto principal aparece com um selo +N indicando os itens adicionais.
    • A chave secreta completa as vendas. Se ela for revogada depois da conexão, as vendas de pedidos avulsos continuam sendo registradas, mas faturas e cobranças chegam sem produto (o filtro de produto do gatilho deixa de casar) e os chargebacks são ignorados.

    Filtrar por produto

    O filtro de produto do gatilho funciona de forma diferente para pedidos avulsos e para assinaturas:

    • Pedidos avulsos (order.*, Pix/boleto gerado, reembolso e chargeback de pedido): o filtro casa pelo código do item do pedido (o SKU que você envia à Pagar.me).
    • Pedidos de link de pagamento não têm código no item. Nesse caso o filtro casa pelo nome do item — se você renomear o item na Pagar.me, o gatilho para de disparar. Reabra o gatilho, selecione o produto de novo e salve.
    • Assinaturas e faturas (subscription.*, invoice.*, e reembolso ou chargeback de uma cobrança de assinatura): o filtro casa pelo plano. Escolha o plano na lista, que a Clickmax busca direto da sua Pagar.me com a chave secreta. Renomear o plano não quebra o filtro.

    A lista do filtro mostra seus planos da Pagar.me e os produtos que já chegaram em pedidos anteriores. Se o produto ainda não apareceu em nenhum pedido, você pode cadastrá-lo manualmente pelo código (ou pelo nome, no caso de link de pagamento).

    Relacionados

    Se não funcionou

    • Não consigo criar a integração: confira se você colou a chave secreta (sk_…), não a chave pública (pk_…). Se a chave foi revogada, gere outra em Configurações > Chaves de API na Pagar.me. Veja os códigos de erro.
    • A Clickmax diz que as chaves são de ambientes diferentes: a chave pública precisa ser do mesmo ambiente da chave secreta. Use pk_test_ com sk_test_ (teste) ou pk_ com sk_ (produção).
    • O bloco Checkout Pagar.me não vende: confira se a chave pública está na integração e se o domínio da página está liberado em Configurações > Conta > Domínios na Pagar.me. Veja Como vender pela Pagar.me direto na minha página.
    • Nenhum evento chega ou os webhooks aparecem como recusados na Pagar.me: a autenticação do webhook está desativada ou o usuário/senha não confere. Na Pagar.me, edite o webhook, ative Habilitar autenticação e cole o Usuário do webhook (clickmax) e a Senha do webhook que aparecem no topo da integração na Clickmax. Isso vale também para webhooks cadastrados antes de a autenticação ser exigida.
    • Ainda nada chega: confira se a URL da Clickmax foi cadastrada no webhook da Pagar.me e se os eventos do passo 8 estão selecionados.
    • Faturas e cobranças chegam sem produto ou chargebacks não aparecem: a chave secreta da integração foi revogada. Gere outra em Configurações > Chaves de API na Pagar.me, edite a integração na Clickmax e cole a nova chave.
    • Um estorno de pedido não aparece: confira se o evento order.canceled está selecionado no webhook.
    • Um evento específico não chega: eventos sem o e-mail do cliente são descartados (a Clickmax não consegue resolver o contato).
    • A automação de um pedido de link de pagamento parou de disparar: o item provavelmente foi renomeado na Pagar.me. Reabra o gatilho, selecione o produto de novo e salve.