ebay_get_payouts
List seller payouts from eBay Finances within the last five years, filter by payout date or status, then page and sort results for reconciliation.
Instructions
List seller payouts from the eBay Finances API (last five years). Filter by payoutDate range and/or payoutStatus, page with limit/offset, sort by payoutDate. Returns a success status with no data when nothing matches. Requires the sell.finances scope. eBay requires Digital Signatures on Finances API calls for EU/UK sellers; set EBAY_SIGNING_KEY_JWE and EBAY_SIGNING_PRIVATE_KEY to sign them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Set to payoutDate (or lastAttemptedPayoutDate for retryable failures) for oldest first. eBay sorts newest first by default. | |
| limit | No | Records per page, up to 200 (eBay default 20) | |
| filter | No | Payout filter. Criteria: payoutDate:[2024-12-17T00:00:01.000Z..2024-12-24T00:00:01.000Z] (within the last five years, range up to 36 months); payoutStatus:{SUCCEEDED} (one PayoutStatusEnum value, e.g. INITIATED, SUCCEEDED, RETRYABLE_FAILED, TERMINAL_FAILED, REVERSED); lastAttemptedPayoutDate:[start..end] (requires payoutStatus:{RETRYABLE_FAILED}); payoutReference:{5********3} (mainland China sellers only). Separate multiple criteria with commas. eBay returns payouts in all states from the last five years when omitted. | |
| offset | No | Zero-based number of payouts to skip; keep below 5000 for response time (eBay default 0) | |
| marketplaceId | No | Overrides the X-EBAY-C-MARKETPLACE-ID header, e.g. EBAY_US, EBAY_GB or EBAY_DE. Defaults to EBAY_MARKETPLACE_ID; eBay assumes EBAY_US when the header is absent. |