Documentação da API

A API da Pagniv permite criar cobranças Pix, gerenciar carteira, saques, disputas e muito mais. Tudo via REST com respostas JSON padronizadas.

Base URL

Produção

https://api.pagniv.com/v1

Todas as requisições devem usar HTTPS.

Formato de resposta

Todas as respostas seguem o mesmo formato:

SucessoJSON

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

ErroJSON

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

Paginação

Endpoints que retornam listas suportam paginação via query params:

Exemplo paginadoJSON

GET /v1/charges?page=1&limit=20

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

Ambientes

Produção

Transações reais processadas pelos provedores Pix.

API Key: sk_production_*

Sandbox

Ambiente de teste. Nenhuma transação real é processada.

API Key: sk_sandbox_*

Rate Limiting

A API implementa rate limiting para proteger o serviço. Os limites são retornados nos headers da resposta:

Headers de Rate Limit

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1700000000