<- Payouts API

Payouts API

List payout entries

GET

 /v2/payouts/{payout_id}/payout-entries

Retrieves a list of all payout entries for a specific payout.

To call this endpoint, set PAYOUTS_READ for the OAuth scope.

Permissions:PAYOUTS_READ

Guide

Payouts Guide

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

payout_id

string

Required

The ID of the payout to retrieve the information for.

Link to section

Query parameters

Link to section

sort_order

string

The order in which payout entries 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

payout_entries

The requested list of payout entries, ordered with the given or default sort order.

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.