Pagar.me

API-key · API v5 · cobranças e assinaturas

Conecte sua conta Pagar.me v5 para conferir cobranças e assinaturas antes de gerar comissão.

Conectar

  1. Gere a chave secreta de API da sua conta Pagar.me. Mantenha a chave no servidor.
  2. No IndicaSaaS, abra Gateways → Pagar.me, informe a chave e clique em Conectar. A conexão é validada por uma consulta à API.
  3. No Pagar.me, configure o webhook com a URL completa devolvida, incluindo ?webhookSecret=.... Esse segredo é próprio da conexão, separado da chave da API.

A confirmação da chave não comprova uma venda. Antes da comissão, o IndicaSaaS consulta o evento pela API autenticada. Se ainda não houver eventos, a conexão pode ficar sem identificação externa da conta.

Indicações e créditos de uso

Leia a referência com AFS.getRef() e envie o valor completo, sem interpretar ou encurtar, no metadata.aff_ref ao criar a cobrança. Se retornar null, omita o campo de indicação. Grave a referência no pedido ou na assinatura criada pelo seu servidor.

{
  "metadata": {
    "aff_ref": ref,
    "aff_revenue_type": "credits"
  }
}

Use aff_revenue_type=credits somente para a compra de créditos de uso. Cobranças de assinatura seguem a comissão padrão. O backend do seu SaaS decide esse campo; não aceite o tipo de receita informado livremente pelo comprador.

Verificação

Configure os eventos charge.paid, charge.refunded, charge.partial_canceled, charge.chargedback, charge.updated e subscription.canceled. O mesmo pagamento recebe uma única comissão, mesmo com reentregas. Reembolsos reduzem a comissão correspondente. Cliente novo e número do ciclo dependem de prova do gateway; não são estimados pela contagem de eventos.

A conferência periódica recupera os hooks gerados no Pagar.me. Configure os eventos antes de receber vendas; a conferência não reconstrói eventos que o gateway nunca gerou. Vitória de disputa não é restaurada automaticamente nesta integração.

O novo evento chargeback.received ainda depende de validação do formato recebido. Ele permanece pendente para conferência, sem cálculo automático. Enquanto essa pendência existir, a conciliação da janela não avança. A integração atual reconhece charge.chargedback e cobranças com status chargedback.

A integração usa a consulta oficial de webhooks da API v5. Não conecta contas das APIs antigas. Cupons de indicação não estão habilitados para o Pagar.me.

AtribuiçãoWebhooks