Skip to main content
GET
List cashouts for a specific merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Query Parameters

page
integer
default:1

Page number

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

Number of items per page

Required range: 1 <= x <= 100
status
enum<string>

Filter by cashout status

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

Filter by cashout method

Available options:
PIX
created_at_from
string<date-time>

Filter cashouts from this date (inclusive)

created_at_to
string<date-time>

Filter cashouts to this date (inclusive)

request_id
string

Filter by request ID

origin_bank_account_id
string

Filter by origin bank account ID

destination_bank_account_id
string

Filter by destination bank account ID

sort
enum<string>

Sort by field

Available options:
created_at,
amount,
status

Response

Cashouts retrieved successfully

Paginated cashout list response

data
object[]
required

List of cashouts

pagination
object
required