This type is the base response type of the getPayouts method, and contains an array of one or more payouts (that match the input criteria), the total count of payouts in the response, and various pagination data for the results set.
Types that use Payouts
Not used by any types.
Call that uses Payouts
Note: If this is the last or only page of the result set, the page may contain fewer payouts than the limit value. To determine the number of pages in a result set, divide the total value (total number of payouts matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was
120 (120 total payouts) and the limit value was
50 (show 50 payouts per page), the total number of pages in the result set is three, so the seller would have to make three separate getPayouts calls to view all payouts matching the input criteria.
This field is only returned if there is a next page of results to view based on the current input criteria.
In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to
30 and limit is set to
10, the call retrieves payouts 31 thru 40 from the resulting collection of payouts.
Note: This feature employs a zero-based list, where the first item in the list has an offset of
This field is only returned if there is a previous page of results to view based on the current input criteria.