List all payouts

GET {{baseUrl}}/v1/payouts

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

Request Params

KeyDatatypeRequiredDescription
arrival_date[gt]string
arrival_date[gte]string
arrival_date[lt]string
arrival_date[lte]string
created[gt]string
created[gte]string
created[lt]string
created[lte]string
destinationstringThe ID of an external account - only return payouts sent to this external account.
ending_beforestringA 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[0]stringSpecifies which fields in the response should be expanded.
expand[1]stringSpecifies which fields in the response should be expanded.
limitstringA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterstringA 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.
statusstringOnly return payouts that have the given status: pending, paid, failed, or canceled.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring