ebay_get_payout_summary
Get cumulative eBay payout totals—payout count, transaction count, and total amount—from the Finances API, optionally filtered by date range and payout status.
Instructions
Get cumulative payout totals from the eBay Finances API: payout count, related transaction count, and total amount, optionally filtered by payoutDate range and one payoutStatus. 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 |
|---|---|---|---|
| filter | No | Payout summary 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). Separate multiple criteria with commas. eBay summarizes payouts in all states from the last five years when omitted. | |
| 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. |