Skip to main content

​
Obter Detalhes de um Saque

Retorna os detalhes completos de uma solicitação de saque pelo seu ID. GET /api/withdraws/{id}

​
Parâmetros de Rota

ParâmetroTipoDescrição
idstring (UUID)ID único da solicitação de saque

​
Exemplo de Requisição

curl -X GET "https://upay-sistema-api.onrender.com/api/withdraws/withdraw-uuid-123" \
  -H "Authorization: Bearer SUA_API_KEY"

​
Resposta de Sucesso (200 OK)

{
  "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",
  "externalId": "ext-txn-456",
  "description": "Retirada de lucros Janeiro",
  "paidAt": "2024-01-16T15:00:00Z",
  "completedAt": "2024-01-16T15:05:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T15:05:00Z"
}

​
Cancelar um Saque Pendente

Cancela uma solicitação de saque que ainda está com status PENDING. POST /api/withdraws/{id}/cancel 
curl -X POST "https://upay-sistema-api.onrender.com/api/withdraws/withdraw-uuid-123/cancel" \
  -H "Authorization: Bearer SUA_API_KEY"

{
  "message": "Saque cancelado com sucesso",
  "id": "withdraw-uuid-123",
  "status": "CANCELLED"
}
Apenas saques com status PENDING podem ser cancelados. Saques em PROCESSING ou COMPLETED não podem ser cancelados.