Documentação da API

Tudo que você precisa para começar: base URL, autenticação, formato de resposta e códigos de erro.

Sua primeira requisição

Gere sua API Key em Dashboard → Integrações → Chaves de API, depois cole no terminal:

Criar uma cobrança Pix

curl -X POST https://api.pagniv.com/v1/charges \
  -H "X-API-Key: sk_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"amount": 5000, "description": "Teste"}'

Pronto, você acabou de criar uma cobrança Pix. O campo qrCode é o código copia e cola para o pagador.

Base URL e ambientes

https://api.pagniv.com/v1

Todas as requisições usam HTTPS e JSON. Autentique com o header X-API-Key. Veja detalhes em API Keys.

Produção

Prefixo da chave: sk_live_

Comportamento: Transações reais via Pix

Sandbox

Prefixo da chave: sk_sandbox_

Comportamento: Testes. Nenhuma transação real é processada

Ambiente	Prefixo da chave	Comportamento
`Produção`	sk_live_	Transações reais via Pix
`Sandbox`	sk_sandbox_	Testes. Nenhuma transação real é processada

Valores em centavos

Todos os valores monetários na API são em centavos. R$ 150,00 = 15000. Valor mínimo: 100 (R$ 1,00).

Respostas e paginação

Toda resposta é JSON. Verifique success para saber se deu certo:

✓ Sucesso

JSON

{
  "success": true,
  "data": { ... }
}

✗ Erro

JSON

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O campo amount é obrigatório."
  }
}

Paginação

Endpoints que retornam listas aceitam page e limit (máx. 100) e incluem um objeto meta:

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "pages": 8
  }
}