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.
Query parameters
Return only payouts for the balance with the given ID. The value must be a valid balance token in the format bal_*.
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.
The maximum number of items to return. Defaults to 50 items.
Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
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.
Headers
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
A list of payout objects. For a complete reference of the payout object, refer to the Get payout endpoint documentation.
Changes
Changed in 6 of the 79 revisions of this API.46
- ▲
the response property
///became nullable for the statusresponse-property-became-nullable
- ▲
- ▲
the
response property's min was decreased from1.00to0.00for the response statusresponse-property-min-decreased
- ▲
- ○
the endpoint scheme security
oAuthwas removed from the APIapi-security-removed
- ○
- ○
added the non-success response with the status
response-non-success-status-added
- ○
- ▲
the response property
///became nullable for the statusresponse-property-became-nullable
- ▲
the
///response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ○
removed from the
///response propertyallOflist for the response statusresponse-property-all-of-removed
- ○
added the required property
////to the response with the statusresponse-required-property-added
- ○
added the required property
////to the response with the statusresponse-required-property-added
- ▲
- ○
endpoint added
endpoint-added
- ○
Of the 79 revisions, 9 have no diff computed.