Skip to main content
GET
List withdrawals

Authorizations

Authorization
string
header
required

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

status
enum<string>

Filter by withdrawal status. Possible withdrawal statuses.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
method
enum<string>

Filter by withdrawal method. Public withdrawals currently support PIX only.

Available options:
PIX
currency
enum<string>

Filter by currency. Public withdrawals currently support BRL only.

Available options:
BRL
startDate
string<date-time>

Start of date range (ISO 8601).

endDate
string<date-time>

End of date range (ISO 8601).

page
integer
default:1

Page number for pagination.

Required range: x >= 1
limit
integer
default:20

Number of items per page (1-100).

Required range: 1 <= x <= 100

Response

Withdrawals listed.

withdrawals
object[]
pagination
object