Carteira & Extrato

Consulte o saldo da carteira, histórico de transações e extrato por período.

Consultar saldo

GET

/v1/balance

Auth

Retorna o saldo disponível, pendente e totais acumulados.

Resposta 200JSON

{
  "success": true,
  "data": {
    "availableBalance": 1250.50,
    "pendingBalance": 300.00,
    "totalEarned": 15800.00,
    "totalWithdrawn": 14200.00,
    "totalFeesPaid": 349.50
  }
}

Listar transações

GET

/v1/transactions

Auth

Retorna lista paginada de todas as transações da carteira.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Filtrar por tipo: CREDIT, DEBIT, FEE, WITHDRAWAL
`page`	integer	Não	Página (padrão: 1)
`limit`	integer	Não	Itens por página (padrão: 20)

Resposta 200JSON

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "CREDIT",
      "amount": 149.01,
      "description": "Cobrança #abc123 paga",
      "createdAt": "2026-01-15T11:05:00Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "type": "FEE",
      "amount": -0.99,
      "description": "Taxa cobrança #abc123",
      "createdAt": "2026-01-15T11:05:00Z"
    }
  ],
  "meta": {
    "total": 230,
    "page": 1,
    "limit": 20,
    "pages": 12
  }
}

Extrato por período

GET

/v1/statement

Auth

Retorna transações filtradas por intervalo de datas.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
`startDate`	date	Não	Data início (YYYY-MM-DD)
`endDate`	date	Não	Data fim (YYYY-MM-DD)
`page`	integer	Não	Página (padrão: 1)
`limit`	integer	Não	Itens por página (padrão: 20)

Exemplobash

curl "https://api.pagniv.com/v1/statement?startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer {token}"

Tipos de transação

Tipo	Descrição
`CREDIT`	Valor recebido de uma cobrança paga
`DEBIT`	Débito na carteira (estorno, ajuste)
`FEE`	Taxa cobrada pela plataforma
`WITHDRAWAL`	Saque realizado para conta bancária