Pagnivpagniv
Dashboard

Saques

Solicite, liste e detalhe saques Pix com liquidação D+0.

Referência rápida

Quick start

Ciclo de vida do saque

Após solicitar um saque, ele passa pelos seguintes status:

PENDING

Significado: Solicitado, aguardando aprovação

Próximo: → APPROVED ou REJECTED

APPROVED

Significado: Aprovado, será processado

Próximo: → PROCESSING

PROCESSING

Significado: Em processamento no provedor Pix

Próximo: → COMPLETED ou FAILED

COMPLETED

Significado: Pix enviado com sucesso

Próximo: Estado final

FAILED

Significado: Falha no envio. Entre em contato

Próximo: Estado final

REJECTED

Significado: Rejeitado pela equipe Pagniv

Próximo: Estado final

Solicite um saque Pix para qualquer chave:

Solicitar saque
curl -X POST https://api.pagniv.com/v1/withdrawals \
  -H "X-API-Key: sk_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "pixKey": "[email protected]",
    "pixKeyType": "EMAIL"
  }'

Solicitar saque

Solicita um saque do saldo disponível para a chave Pix informada. O valor é debitado imediatamente do saldo e o Pix é processado após aprovação. A taxa pode ser descontada do valor do saque ou do saldo, dependendo da configuração da sua conta.

POST/v1/withdrawals

Autenticação

X-API-Keystringheaderobrigatório

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

Body (JSON)

amountnumberobrigatório

Valor em centavos (mín. 100)

destinationIdstringopcional

ID de um destino de saque salvo (chave Pix ou conta bancária TED). Se informado, dispensa pixKey/pixKeyType. Destinos do tipo conta bancária geram saque TED com aprovação manual.

pixKeystringopcional

Chave Pix destino (obrigatório se não usar destinationId)

pixKeyTypestringopcional

CPF, CNPJ, EMAIL, PHONE ou EVP (obrigatório se não usar destinationId)

sourcestringopcional

Origem do saque: MANUAL (padrão) ou QR_CODE

/v1/withdrawals
curl -X POST https://api.pagniv.com/v1/withdrawals \
  -H "X-API-Key: sk_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "pixKey": "12345678901",
    "pixKeyType": "CPF"
  }'
{
  "success": true,
  "data": {
    "id": "550e8400-...",
    "amount": 50000,
    "fee": 200,
    "netAmount": 49800,
    "status": "PENDING",
    "method": "PIX",
    "pixKey": "12345678901",
    "pixKeyType": "CPF",
    "source": "MANUAL",
    "createdAt": "2026-01-15T14:00:00Z"
  }
}

Pagar via QR (decodificar BR Code)

Lê um Pix copia-e-cola (BR Code) e retorna chave, tipo e valor, para confirmação antes de pagar via POST /v1/withdrawals com source QR_CODE. QR estático lê a chave do payload; QR dinâmico resolve a URL embutida (busca o JWS no PSP do recebedor). Obs: o pagamento sai por chave, sem repassar o txid, então a cobrança dinâmica do recebedor pode não dar baixa automática.

POST/v1/withdrawals/decode-qr

Autenticação

X-API-Keystringheaderobrigatório

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

Body (JSON)

brCodestringobrigatório

Pix copia-e-cola (payload EMV do QR)

/v1/withdrawals/decode-qr
curl -X POST https://api.pagniv.com/v1/withdrawals/decode-qr \
  -H "X-API-Key: sk_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "brCode": "00020126330014br.gov.bcb.pix0111..."
  }'
{
  "success": true,
  "data": {
    "pixKey": "12345678901",
    "pixKeyType": "CPF",
    "amount": 1000,
    "merchantName": "Fulano de Tal",
    "merchantCity": "BRASILIA",
    "txid": "***"
  }
}

Listar saques

Lista seus saques com filtro por status. Use para acompanhar o andamento de cada solicitação.

GET/v1/withdrawals

Autenticação

X-API-Keystringheaderobrigatório

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

Query params

statusstringopcional

PENDING, APPROVED, PROCESSING, COMPLETED, FAILED, REJECTED

pageintegeropcional

Página (padrão: 1)

limitintegeropcional

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

/v1/withdrawals
curl "https://api.pagniv.com/v1/withdrawals?status=COMPLETED&page=1" \
  -H "X-API-Key: sk_live_sua_chave"
{
  "success": true,
  "data": [
    {
      "id": "550e8400-...",
      "amount": 50000,
      "status": "COMPLETED",
      "pixKey": "12345678901",
      "source": "QR_CODE",
      "createdAt": "2026-01-15T14:00:00Z"
    }
  ],
  "meta": { "total": 12, "page": 1, "limit": 20, "pages": 1 }
}

Detalhar saque

Retorna todos os dados de um saque: valor, taxa, chave Pix, status e timestamps.

GET/v1/withdrawals/{id}

Autenticação

X-API-Keystringheaderobrigatório

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

/v1/withdrawals/{id}
curl "https://api.pagniv.com/v1/withdrawals/{id}" \
  -H "X-API-Key: sk_live_sua_chave"
{
  "success": true,
  "data": {
    "id": "550e8400-...",
    "amount": 50000,
    "fee": 200,
    "netAmount": 49800,
    "status": "PENDING",
    "method": "PIX",
    "pixKey": "12345678901",
    "pixKeyType": "CPF",
    "source": "MANUAL",
    "createdAt": "2026-01-15T14:00:00Z"
  }
}