provider GET /v1/payouts
@utdk/stripe /v1/payouts
List all payouts
<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>
arrival_date query
Only return payouts that are expected to arrive during the given date interval.
created query
Only return payouts that were created during the given date interval.
destination query
The ID of an external account - only return payouts sent to this external account.
string
ending_before query
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.
string
expand query
Specifies which fields in the response should be expanded.
array
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
starting_after query
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.
string
status query
Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getpayouts
GET/v1/payouts
<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>

Only return payouts that are expected to arrive during the given date interval.

Only return payouts that were created during the given date interval.

The ID of an external account - only return payouts sent to this external account.

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.

Specifies which fields in the response should be expanded.

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

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.

Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getpayouts()