Saques

Solicite saques do saldo disponível para qualquer chave Pix. Saques podem ser manuais ou automáticos conforme configuração.

Solicitar saque

POST

/v1/withdrawals

Auth

Cria uma nova solicitação de saque para a chave Pix informada.

Body (JSON)

Parâmetro	Tipo	Obrigatório	Descrição
`amount`	number	Sim	Valor do saque (mín. 0.01)
`pixKey`	string	Sim	Chave Pix destino
`pixKeyType`	string	Sim	Tipo: CPF, CNPJ, EMAIL, PHONE ou EVP

Exemplobash

curl -X POST https://api.pagniv.com/v1/withdrawals \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500.00,
    "pixKey": "12345678901",
    "pixKeyType": "CPF"
  }'

Resposta 201JSON

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "amount": 500.00,
    "fee": 2.00,
    "netAmount": 498.00,
    "status": "PENDING",
    "pixKey": "12345678901",
    "pixKeyType": "CPF",
    "createdAt": "2026-01-15T14:00:00Z"
  }
}

Listar saques

GET

/v1/withdrawals

Auth

Retorna lista paginada de saques do merchant.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	PENDING, APPROVED, PROCESSING, COMPLETED, FAILED, REJECTED
`page`	integer	Não	Página (padrão: 1)
`limit`	integer	Não	Itens por página (padrão: 20)

Detalhar saque

GET

/v1/withdrawals/{id}

Auth

Retorna detalhes de um saque específico.

Modos de saque

O modo de saque é configurado pelo admin na aprovação do merchant.

Modo	Descrição
`MANUAL`	Merchant solicita saque manualmente pelo dashboard ou API
`AUTO_D1`	Saque automático no dia útil seguinte (D+1)
`AUTO_D2`	Saque automático em dois dias úteis (D+2)
`WEEKLY`	Saque automático semanal (toda segunda-feira)

Tipos de chave Pix

Tipo	Formato
`CPF`	11 dígitos numéricos
`CNPJ`	14 dígitos numéricos
`EMAIL`	Email válido
`PHONE`	+55 seguido de DDD e número
`EVP`	Chave aleatória (UUID)