Skip to main content

​
Base URL

https://api.pagozz.com/v1

​
Autenticação

Todas as requisições devem incluir o header Pagozz-Token: 
curl https://api.pagozz.com/v1/links \
  -H "Pagozz-Token: pgz_live_XXXXXXXXXXXXXXXXXXXXXXXX"
O prefixo da chave determina o ambiente:
  • pgz_test_* — Sandbox (pagamentos simulados)
  • pgz_live_* — Produção (pagamentos reais)

​
Versionamento

Inclua o header Pagozz-Version para fixar a versão da API: 
curl https://api.pagozz.com/v1/links \
  -H "Pagozz-Version: 2026-03-15"
Versão atual: 2026-03-15 (usada como padrão se o header for omitido).

​
Formato das respostas

Sucesso: 
{
  "data": { ... }
}
Erro: 
{
  "error": {
    "code": "validation_error",
    "message": "O campo 'amount' deve ser maior ou igual a 100.",
    "field": "amount"
  }
}

​
Valores monetários

Todos os valores são em centavos (inteiros). R$ 10,00 = 1000.

​
Convenções

  • Campos de request e response usam snake_case
  • IDs são UUID v4
  • Datas são ISO 8601 com timezone UTC
  • Paginação: page (começa em 1) e page_size (máximo 100)

​
Rate limiting

ContextoLimite
API key autenticada100 req/min por conta
Público20 req/min
Ao exceder: resposta 429 Too Many Requests.

​
Recursos

RecursoDescrição
LinksLinks de pagamento
PaymentsCobranças PIX e cartão
CyclesCobranças recorrentes
PlansPlanos de assinatura
InvoicesFaturas de ciclos
WebhooksEndpoints de webhook
SimulationSimulação (test mode)