List withdrawals
Withdrawals
List withdrawals
Retrieve a paginated list of withdrawals with optional filters.
GET
List withdrawals
Authorizations
YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.
Query Parameters
Filter by withdrawal status. Possible withdrawal statuses.
Available options:
PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED Filter by withdrawal method. Public withdrawals currently support PIX only.
Available options:
PIX Filter by currency. Public withdrawals currently support BRL only.
Available options:
BRL Start of date range (ISO 8601).
End of date range (ISO 8601).
Page number for pagination.
Required range:
x >= 1Number of items per page (1-100).
Required range:
1 <= x <= 100
