List Payouts
GET/api/ebay/:integrationInstance/payouts
Returns a paginated list of eBay Managed Payments payouts synced for the integration instance. Each payout includes the settlement amount, a normalized summary split (sales, refunds, fees, shipping labels, charges, disputes, adjustments, and net), the accounting status, and the number of transaction lines.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Filterable columns: status, currency, accounting_status (text), amount (numeric), payout_date (date), created_at (datetime). filter[search] matches the payout ID and currency.
Filtering: pass filter[column]=value for an exact match, or filter[column.operator]=value with operators such as contains, does_not_contain, is, is_not, is_one_of, starts_with, ends_with, is_empty, is_not_empty (text), greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (numeric), and is, is_not, before, after, on_or_before, on_or_after, between, today, yesterday, past_week, past_month, past_year, days_ago, past_days (date/datetime). Complex AND/OR trees can be sent as a base64-encoded JSON tree in the filter_groups parameter.
Allowed sorts: id, legacy_resource_id, payout_date, amount, status, accounting_status (prefix with - for descending; default -payout_date). Pagination defaults to 10 per page.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.