Sample - Stripe API
GET/v1/payouts

List all payouts

Lists existing payouts sent to third-party bank accounts or paid to connected accounts. Use arrival_date, created, destination, and status to filter results, and use cursor parameters to navigate the list in reverse chronological order.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

8 parameters
arrival_dateobjectoptional
Filters payouts by their expected arrival date, using a Unix timestamp or a date-range object with `gt`, `gte`, `lt`, or `lte`.
createdobjectoptional
Filters payouts by creation date, using a Unix timestamp or a date-range object with `gt`, `gte`, `lt`, or `lte`.
destinationstringoptional
The ID of the external account that received the payout.
ending_beforestringoptional
A cursor identifying an object in the list; use it to retrieve the preceding page.
expandarray<string>optional
Specifies response fields to expand; each field name can contain up to 5000 characters.
limitintegeroptional
The number of payouts to return. Must be between 1 and 100 and defaults to 10 when omitted.
starting_afterstringoptional
A cursor identifying an object in the list; use it to retrieve the following page.
statusstringoptional
Filters payouts by status: `pending`, `paid`, `failed`, or `canceled`.

2 status codes
200Returns a list object containing payout objects in reverse chronological order, together with pagination metadata including `has_more` and the list URL.
dataarray<Payout>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the request cannot be processed; the response contains an error object with a `type` field.
errorobjectrequired

Error handling

limit must be between 1 and 100 and defaults to 10 when omitted. status must be one of pending, paid, failed, or canceled; arrival_date and created accept either a Unix timestamp or a range object.