Skip to main content
GET
/
api
/
withdraws
Listar Saques
curl --request GET \
  --url https://upay-sistema-api.onrender.com/api/withdraws \
  --header 'API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amountCents": 5000,
      "feeCents": 350,
      "netAmount": 4650,
      "status": "PENDING",
      "pixKeyType": "cpf",
      "pixKey": "<string>",
      "externalId": "<string>",
      "failureReason": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "processedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Query Parameters

page
integer
default:1

Pagina atual

limit
integer
default:20

Resultados por pagina (max. 100)

status
enum<string>

Filtrar por status

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED

Response

Lista de saques retornada com sucesso

data
object[]
meta
object