List payouts

GET /v2/payouts

Retrieves a list of all payouts for the default location.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the Developer Console Sign In

Parameters

location_id

The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

string

status

If provided, only payouts with the given status are returned.

string

Select status

SENT Indicates that the payout was successfully sent to the banking destination.
FAILED Indicates that the payout was rejected by the banking destination.
PAID Indicates that the payout has successfully completed.

begin_time

The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

string

end_time

The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

string

sort_order

The order in which payouts are listed.

string

Select sort_order

DESC The results are returned in descending e.g., newest-first or Z-A order.
ASC The results are returned in ascending e.g., oldest-first or A-Z order.

cursor

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see Pagination. If request parameters change between requests, subsequent results may contain duplicates or missing records.

string

limit

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: 100

integer

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums