Pagnivpagniv
Dashboard

Carteira & Extrato

Consulte saldo, liste transações e exporte extrato por período.

Referência rápida

Quick start

Consulte o saldo disponível para saque:

Consultar saldo
curl https://api.pagniv.com/v1/balance \
  -H "X-API-Key: sk_live_sua_chave"

Consultar saldo

Retorna todos os saldos da sua carteira (disponível, pendente, reservado, bloqueado) e o breakdown por método de pagamento.

GET/v1/balance

Autenticação

X-API-Keystringheaderobrigatório

Sua chave de API no header X-API-Key: sk_live_.... Gere em Dashboard → Integrações.

Campos de saldo

availableBalance

Disponível para saque

pendingBalance

Pendente (sempre 0 em Pix, liquidação D+0 instantânea)

reservedBalance

Reservado para disputas abertas

blockedBalance

Bloqueado por ação administrativa

totalEarned

Total bruto recebido

totalWithdrawn

Total sacado

totalFeesPaid

Total pago em taxas

/v1/balance
curl "https://api.pagniv.com/v1/balance" \
  -H "X-API-Key: sk_live_sua_chave"
{
  "success": true,
  "data": {
    "availableBalance": 125050,
    "withdrawableBalance": 110050,
    "disputeDebt": 0,
    "pendingBalance": 30000,
    "reservedBalance": 15000,
    "blockedBalance": 0,
    "totalEarned": 1580000,
    "totalWithdrawn": 1420000,
    "totalFeesPaid": 34950,
    "breakdown": {
      "PIX": { "availableBalance": 110050, "pendingBalance": 20000 },
      "CARD": { "availableBalance": 10000, "pendingBalance": 8000 },
      "BOLETO": { "availableBalance": 5000, "pendingBalance": 2000 }
    }
  }
}

Listar transações

Lista todas as movimentações da carteira: créditos, débitos, taxas, saques e reservas de disputa.

GET/v1/transactions

Autenticação

X-API-Keystringheaderobrigatório

Sua chave de API no header X-API-Key: sk_live_.... Gere em Dashboard → Integrações.

Query params

typestringopcional

CREDIT, DEBIT, FEE, WITHDRAWAL, REFUND, DISPUTE_RESERVE, DISPUTE_RELEASE, DISPUTE_DEFICIT

flowstringopcional

"in" só o que entrou, "out" só o que saiu (pelo sinal do valor)

paymentMethodstringopcional

PIX, CARD ou BOLETO

startDatedateopcional

Data início (YYYY-MM-DD)

endDatedateopcional

Data fim (YYYY-MM-DD)

searchstringopcional

Busca na descrição, no ID da cobrança ou no ID do saque

minAmountintegeropcional

Valor mínimo em centavos. Compara o valor ABSOLUTO: vale para entrada e para saída

maxAmountintegeropcional

Valor máximo em centavos, também pelo valor absoluto

pageintegeropcional

Página (padrão: 1)

limitintegeropcional

Itens por página (padrão: 20)

/v1/transactions
curl "https://api.pagniv.com/v1/transactions?flow=out&page=1" \
  -H "X-API-Key: sk_live_sua_chave"
{
  "success": true,
  "data": [
    {
      "id": "550e8400-...",
      "type": "CREDIT",
      "amount": 14901,
      "description": "Pagamento recebido - abc123",
      "createdAt": "2026-01-15T11:05:00Z"
    }
  ],
  "meta": { "total": 230, "page": 1, "limit": 20, "pages": 12 }
}

Extrato por período

Igual a listar transações, mas filtrado por período. Útil para gerar relatórios e conciliação.

GET/v1/statement

Autenticação

X-API-Keystringheaderobrigatório

Sua chave de API no header X-API-Key: sk_live_.... Gere em Dashboard → Integrações.

Query params

startDatedateopcional

Data início (YYYY-MM-DD)

endDatedateopcional

Data fim (YYYY-MM-DD)

pageintegeropcional

Página (padrão: 1)

limitintegeropcional

Itens por página (padrão: 20)

/v1/statement
curl "https://api.pagniv.com/v1/statement?startDate=2026-01-01&endDate=2026-01-31" \
  -H "X-API-Key: sk_live_sua_chave"
{
  "success": true,
  "data": [
    {
      "id": "550e8400-...",
      "type": "CREDIT",
      "amount": 14901,
      "description": "Pagamento recebido",
      "createdAt": "2026-01-15T11:05:00Z"
    }
  ],
  "meta": { "total": 50, "page": 1, "limit": 20, "pages": 3 }
}