Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: x <= 200
status
enum<string>
Available options:
pending,
processing,
completed,
failed
country
string

Filter by destination country (ISO 3166-1 alpha-2, e.g. CL, PE, MX).

from
string<date>

Filter from this date (YYYY-MM-DD, UTC, inclusive).

to
string<date>

Filter up to this date (YYYY-MM-DD, UTC, inclusive).

format
enum<string>

Export the same rows as a file: csv or xlsx (accounting-grade download, up to 10,000 rows; same filters and date range). Omit for the JSON view.

Available options:
csv,
xlsx

Response

Paged payouts.

page
integer
page_size
integer
payouts
object[]
Last modified on July 19, 2026