Skip to main content

​
Listar Solicitações de Saque

Retorna a lista paginada de todas as solicitações de saque do usuário autenticado. GET /api/withdraws

​
Parâmetros de Query

ParâmetroTipoDescriçãoPadrão
pagenumberNúmero da página1
limitnumberItens por página (máx. 100)20
statusstringFiltrar por status: PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED-

​
Exemplo de Requisição

curl -X GET "https://upay-sistema-api.onrender.com/api/withdraws?page=1&limit=20" \
  -H "Authorization: Bearer SUA_API_KEY"

​
Resposta de Sucesso (200 OK)

{
  "data": [
    {
      "id": "withdraw-uuid-123",
      "amountCents": 50000,
      "feeCents": 200,
      "netAmount": 49800,
      "status": "COMPLETED",
      "pixKey": "123.456.789-00",
      "pixKeyType": "cpf",
      "beneficiaryName": "João Silva",
      "externalReference": "ref-123",
      "paidAt": "2024-01-16T15:00:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T15:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Status possíveis

StatusDescrição
PENDINGAguardando processamento
PROCESSINGEm processamento pelo provedor
COMPLETEDTransferência concluída com sucesso
FAILEDTransferência falhou
CANCELLEDCancelado pelo usuário