Documentação da API PagPolar
Guias passo a passo, a referência de cada operação e os avisos de webhook para integrar a sua loja à PagPolar.
Fundamentos
O que vale para toda a API: endereço, token, erros, repetição segura e formato dos valores.
Ambientes e URL baseO endereço da API e o que muda entre Produção e Homologação.AutenticaçãoTroque a chave pelo token e envie em Authorization.ErrosO formato do erro, o que pode ser repetido e o request_id.IdempotênciaRepita uma cobrança sem cobrar o cliente duas vezes.Paginação e filtrosPercorra qualquer listagem do começo ao fim.Valores, datas e identificadoresCentavos, fuso e os tipos de identificador da API.
Jornadas
O caminho completo de cada objetivo, da primeira chamada ao aviso de webhook.
Criar produto e ofertaCadastre o produto e a oferta com preço, meios de pagamento e parcelas.Vender com PIX ou boletoCobre, mostre o código de pagamento e confirme pelo webhook.Vender com cartão de créditoCobre à vista ou parcelado e saiba se foi aprovado ou recusado.Vender um produto físicoConsulte o frete pelo CEP, cobre com o endereço e acompanhe o pedido.Vender uma assinaturaCrie o plano, assine o cliente no cartão e acompanhe as renovações.Acompanhar reembolsosReceba o pedido, consulte na API e reaja ao estorno e ao chargeback.Conciliar vendasBaixe as vendas e assinaturas de um período sem perder nem duplicar.
Referência da API
O contrato de cada operação: caminho, parâmetros, corpo, respostas e erros.
AutenticaçãoTroque a chave pelo token de acesso e confira a credencial.VendasCobre por PIX, boleto ou cartão e consulte as vendas.Produtos e ofertasCrie e altere produtos e as ofertas com preço e parcelas.Planos e assinaturasPlanos, ofertas de plano, troca de plano e troca de cartão.ReembolsosListe os pedidos de reembolso e peça o reembolso de uma venda.EntidadesOs campos de cada objeto que a API devolve ou recebe.
Webhooks
Os avisos que a PagPolar envia ao seu servidor quando algo muda.
Visão geralComo o aviso chega, o que ele traz e quando usar.PlaygroundMonte um evento de teste, edite o JSON e envie para o seu webhook.Configurar o webhookCadastre a URL, escolha os eventos e entenda o token.Formato do eventoO envelope e cada bloco de dados do aviso.Processar sem duplicarTrate repetições, ordem fora de sequência e envios de teste.Catálogo de eventosOs 15 eventos, quando cada um dispara e o que fazer.