List all payouts

GetPayouts

<p>Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.</p>

Parameters

Name	In	Type	Required	Description
arrival_date	query	object | integer	no	Only return payouts that are expected to arrive during the given date interval.
created	query	object | integer	no	Only return payouts that were created during the given date interval.
destination	query	string	no	The ID of an external account - only return payouts sent to this external account.
ending_before	query	string	no	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	string[]	no	Specifies which fields in the response should be expanded.
limit	query	integer	no	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	string	no	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	string	no	Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.

Request Body

application/x-www-form-urlencoded

Responses

200 Successful response.

default Error response.