Skip to main content
GET
List payout requests

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Use the JWT token obtained from the login endpoint in the Authorization header as 'Bearer {token}'.

Query Parameters

merchantId
string

Filter by submerchant ID

Example:

"36OO3bcGjhPjjF3tzrqOGcmQuKo"

status
enum<string>

Filter by request status

Available options:
pending,
approved,
rejected,
processing
Example:

"pending"

currency
string

Filter by currency

Example:

"BRL"

createdAtStart
string<date>

Data inicial (inclusiva) do filtro por created_at

Example:

"2025-12-01"

createdAtEnd
string<date>

Data final (inclusiva) do filtro por created_at

Example:

"2025-12-31"

page
integer
default:1

Page number (starts at 1)

Example:

1

size
integer
default:10

Number of items per page

Example:

20

orderBy
string

Order results by fields (comma-separated). Prefix with - for descending order.

Example:

"createdAt,-amount"

Response

Successfully retrieved the list of payout requests

data
object[]

Array of payout requests in the current page

page
integer

Current page number

Example:

1

pages
integer

Total number of pages available

Example:

10

total
integer

Total number of payout requests across all pages

Example:

100

size
integer

Number of payout requests per page

Example:

10

pendingCount
integer

Total number of payout requests in pending status (across all pages).

Example:

3