List Payouts

Applies to: Payouts APIPayouts API | OAuth APIOAuth API

Learn how to filter payouts by location ID, status, and time range and sort them in ascending or descending order.

Link to section

Overview

The ListPayoutsListPayouts endpoint provides a list of payouts for a location. If you don't specify a location, the main or default locationmain or default location is used. To call this endpoint, set PAYOUTS_READ for the OAuth scope.

The ListPayouts endpoint supports pagination and a limit field that your application can use to indicate the page size (the number of items to return in the response). The default and maximum page size is 100 items. For more information, see PaginationPagination.

List payouts

Copy

The following is an example response:

Copy
Expand

To see payouts for a specific location, specify the location ID:

List payouts

Copy

The following is an example response:

Copy
Expand

By default, results are returned from oldest to newest (or Z to A) in descending order. To switch to ascending order, set sort_order to ASC. For more details, see SortOrderSortOrder.

To see payouts in a specific time range, specify the dates in the following format (see Working with DatesWorking with Dates):

List payouts

Copy

The following is an example response:

Copy
Expand
Link to section

See also

On this page