Onde começar?
Veja o que a API faz, o que você precisa antes de integrar e quais rotas e eventos usar em cada objetivo.
É um agente de IA? Comece por aqui
Leia /docs/llms.txt: é o índice desta documentação em texto, com o endereço e o resumo de cada página. O contrato completo da API está em /docs/openapi.json (OpenAPI 3.0) e o dos webhooks em /docs/webhooks.json (OpenAPI 3.1). Qualquer página pode ser lida em markdown acrescentando .mdx ao endereço ou enviando o header Accept: text/markdown.
A API da PagPolar deixa o seu sistema vender sem passar pelo checkout da PagPolar. Com ela você:
- cria produtos, ofertas, planos e ofertas de plano;
- cobra por PIX, boleto ou cartão de crédito;
- assina um cliente em um plano, com cobrança no cartão;
- consulta vendas, pedidos de reembolso, assinaturas e clientes;
- recebe avisos no seu servidor quando uma venda ou uma assinatura muda (webhooks).
Antes de começar
Você precisa de três coisas:
- Uma conta de vendedor na PagPolar com o menu Configurações → API no painel. É nessa tela que você cria a credencial.
- Um servidor seu para chamar a API. Veja Chame a API do seu servidor.
- Uma URL pública no seu servidor para receber os webhooks.
Comece pela chave de Homologação, que leva as chamadas para o ambiente de testes, e troque pela chave de Produção quando a integração estiver pronta.
Qual rota chamar
Cada objetivo abaixo lista as operações na ordem em que você as chama e o evento de webhook que avisa o resultado.
Antes de qualquer uma delas, obtenha o token de acesso. O passo a passo de cada objetivo está no guia da jornada indicado em cada seção.
Escolha pelo tipo de cobrança
Vender um produto avulso
- Crie o produto:
POST /products. Veja Criar produto e oferta. - Crie a oferta, com preço e meios de pagamento:
POST /offers. Se preferir, informe a oferta na hora da venda. - Cobre o cliente:
- PIX:
POST /payments/pix; - boleto:
POST /payments/boleto; - cartão:
POST /payments/credit-card.
- PIX:
- Espere o aviso de pagamento:
TRANSACTION_PAID.
Se o produto é físico, a cobrança exige o endereço e a opção de frete, consultada antes em GET /offers/{identifier}/shipping. Veja Vender um produto físico.
Guias: Início rápido, Vender com PIX ou boleto, Vender com cartão de crédito e Vender com afiliado.
Vender uma assinatura
Pela API, a assinatura é sempre cobrada no cartão de crédito.
- Crie o plano:
POST /plans. - Crie a oferta de plano, com preço e ciclo:
POST /plans/{id}/offers. - Assine o cliente:
POST /plans/offer/{id}/subscribe. - Acompanhe o status pelos webhooks e por
GET /subscriptions/{id}. Quando liberar o acesso está em Ciclo de vida da assinatura. - Para cancelar:
DELETE /subscriptions/{id}.
Guias: Assinar um plano, Cancelar assinatura, Trocar de plano e Trocar o cartão da assinatura.
Acompanhar o que acontece depois da venda
- Receba os avisos no seu servidor: Visão geral dos webhooks.
- Veja cada status da venda e o evento que avisa: Ciclo de vida da venda.
- Liste os pedidos de reembolso:
GET /refunds. Veja Acompanhar reembolsos e chargebacks.
Conferir e conciliar dados
- Liste as vendas de um período:
GET /sales. Veja Paginação e filtros. - Consulte uma venda pelo id, pelo código ou pela sua referência do pedido:
GET /sales/{identifier}. Veja Como a venda é encontrada. - Liste as assinaturas:
GET /subscriptions. - Liste os clientes:
GET /customers.