Saques
Listar saques
Lista todos os saques realizados com suporte a filtros e paginação.
Authorization
BearerAuth AuthorizationBearer <token>
Token de Saque no formato Bearer Token. NUNCA exponha este token no client-side.
In: header
Query Parameters
status?string
Filtrar por status do saque
Value in
"pending" | "processing" | "completed" | "failed"limit?integer
Número máximo de resultados
Default
20Range
1 <= value <= 100offset?integer
Número de resultados para pular
Default
0Range
0 <= valuecreated_from?string
Filtrar saques criados a partir desta data (ISO 8601)
Format
date-timecreated_to?string
Filtrar saques criados até esta data (ISO 8601)
Format
date-timeResponse Body
application/json
application/json
curl -X GET "https://api.exemplo.com/v1/withdrawals"{
"data": [
{
"id": "wth_123456789",
"status": "completed",
"amount": 5000,
"currency": "BRL",
"pix_key": "usuario@exemplo.com",
"created_at": "2024-01-15T10:00:00Z",
"processed_at": "2024-01-15T14:00:00Z"
},
{
"id": "wth_987654321",
"status": "pending",
"amount": 3000,
"currency": "BRL",
"pix_key": "outro@exemplo.com",
"created_at": "2024-01-15T09:00:00Z"
}
],
"pagination": {
"total": 2,
"limit": 20,
"offset": 0
}
}{
"error": "Unauthorized",
"details": {
"message": "Invalid or missing token"
}
}