v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Payouts API

List payouts

Retrieve a list of all payouts for your organization, including payouts initiated automatically by the balance's payout schedule and payouts requested via the API or dashboard.

Only payouts created on or after April 1st, 2026 are returned.

The results are paginated. Use the from query parameter together with _links.next to iterate through the full result set.

🔑 Access with

API key

Advanced access token with payouts.read

get/payouts

Query parameters

balanceIdstring nullable

Example:bal_gVMhHKqSSRYJyPsuoPNFH

Return only payouts for the balance with the given ID. The value must be a valid balance token in the format bal_*.

fromstring

Example:payout_j8NvRAM2WNZtsykpLEX8J

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable

Example:50

The maximum number of items to return. Defaults to 50 items.

sortstring

Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of payout objects. For a complete reference of the payout object, refer to the Get payout endpoint documentation.