List payout requests
Lists all payout requests with support for filters and pagination.
Authorizations
JWT Bearer token authentication. Use the JWT token obtained from the login endpoint in the Authorization header as 'Bearer {token}'.
Query Parameters
Filter by submerchant ID
"36OO3bcGjhPjjF3tzrqOGcmQuKo"
Filter by request status
pending, approved, rejected, processing "pending"
Filter by currency
"BRL"
Data inicial (inclusiva) do filtro por created_at
"2025-12-01"
Data final (inclusiva) do filtro por created_at
"2025-12-31"
Page number (starts at 1)
1
Number of items per page
20
Order results by fields (comma-separated). Prefix with - for descending order.
"createdAt,-amount"
Response
Successfully retrieved the list of payout requests
Array of payout requests in the current page
Current page number
1
Total number of pages available
10
Total number of payout requests across all pages
100
Number of payout requests per page
10
Total number of payout requests in pending status (across all pages).
3