<- Payouts API

Payouts API

All versions ->

List payouts

GET

 /v2/payouts

Retrieves a list of all payouts for the default location.

You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

Permissions:PAYOUTS_READ

Guide

Payouts Guide

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

location_id

string

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.

Link to section

status

string

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

Link to section

begin_time

string

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

Link to section

end_time

string

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

Link to section

sort_order

string

The order in which payouts are listed.

Link to section

cursor

string

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.

Link to section

limit

integer(32-bit)

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

Link to section

Response fields

Link to section

payouts

The requested list of payouts.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see Pagination.

Link to section

errors

Information about errors encountered during the request.