canonical: https://jentic.com/apis/apiz.ebay.com

# eBay APIs

eBay's seller-side APIs on the apiz.ebay.com host let applications authenticate an eBay user and read their financial activity. The Identity API confirms who an OAuth-authorised user is and returns permitted account profile fields for a Sign in with eBay flow, while the Finances API retrieves seller payouts, funds balances, and the underlying transactions that net to each settlement. Together they cover confirming the active seller and reconciling their cash movement into accounting and reporting systems.

## For AI agents

An agent can sign an eBay user in and confirm which account an OAuth token represents, then pull that seller's payouts, funds balance, and the transactions, refunds, and fees that make up each settlement. This supports building reconciliation, cash-flow reporting, and account-linking flows across eBay's Identity and Finances APIs.

## Scope

Use for: Confirming an authenticated eBay user's identity and reading that seller's payouts, funds balance, and transaction breakdown for reconciliation and reporting

Not supported:
- listing management
- order fulfilment
- refund issuance
- triggering payouts
- account registration
- writing profile data

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Finances API | finance | 7 | Retrieve eBay seller payouts, transaction history, and funds summaries via OAuth so accounting integrations can reconcile cash movement. |
| Identity API | identity-auth | 1 | Authenticate an eBay user and retrieve their account profile fields via OAuth 2.0 'Sign in with eBay'. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Confirm which eBay user an OAuth token represents | commerce-identity | The Identity API's GET /user/ returns the authenticated account profile so you know whose data you are about to read. |
| Retrieve seller payouts, balances, and transactions | sell-finances | The Finances API lists payouts, funds summaries, and the orders, refunds, and fees that net to each settlement for reconciliation. |

## Cross-API use cases

### Confirm the seller then reconcile their payouts

An accounting integration first calls the Identity API to record which eBay account was authorised, then uses the Finances API to pull that seller's payouts and the transactions that net to each one. Storing the eBay user identifier alongside the payout data keeps downstream reconciliation against the correct account unambiguous.

Example prompt: Call GET /user/ to capture the authenticated seller identifier, then call GET /payout and GET /transaction for the last month to build reconciled journal entries tagged to that account.

### Seller cash-flow dashboard with verified account label

A multi-channel dashboard signs the seller in with eBay to display a verified account handle, then shows the live funds balance and recent settlement totals. Identity supplies the account label while Finances supplies the balance and payout figures behind it.

Example prompt: Call GET /user/ for the account handle, then GET /seller_funds_summary and GET /payout_summary for the trailing period and render both under the verified seller label.

### Audit a payout shortfall for the confirmed account

When a seller queries why a settlement came in low, the workflow confirms the active account with Identity, then walks every deduction with Finances. Identity ties the investigation to the right user while the transaction breakdown attributes the gap to specific refunds and disputes.

Example prompt: Call GET /user/ to confirm the account, then GET /payout/{payout_Id} and GET /transaction filtered by that payout to list each refund and dispute deduction.

## Why Jentic

- **Setup:** Wiring these eBay APIs by hand means running the seller OAuth 2.0 flow, refreshing tokens, and mapping both the profile read and the payout and transaction reads against the apiz.ebay.com host yourself. With Jentic you install Jentic One once, add the eBay Identity and Finances APIs from the Jentic directory, store the OAuth credentials once, and your agent calls them by intent.
- **Permission scoping:** Every operation across both APIs is read-only, and Jentic One is self-hosted so your own rules decide which ones the agent may call. You can grant just the single profile lookup and the specific Finances reads you need, and because payout and transfer ids sit in the URL path you can pin the agent to a specific settlement and its summaries.
- **Credential handling:** Your eBay OAuth credentials are stored encrypted by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context, and the instance stays separate from the machine the agent runs on.
- **Discovery method:** Agents search the Jentic directory by intent such as 'get the current eBay user' or 'list eBay seller payouts', and Jentic returns the matching operation with its input and response schema so the agent calls the right endpoint without reading eBay's developer docs.

## Related vendors

- **PayPal** — Alternative settlement and OAuth identity provider for sellers paid or authenticated through PayPal rather than eBay managed payments.
- **QuickBooks** — Common accounting destination sellers reconcile eBay payouts and transactions into.
- **Xero** — Accounting platform that imports eBay settlement data for bookkeeping and reconciliation.
- **Stripe** — Alternative payments and payout data source for multi-channel sellers reconciling cash movement across marketplaces.

## FAQ

### What can an agent do across eBay's Identity and Finances APIs?

It can confirm which eBay account an OAuth token represents through the Identity API, then read that seller's payouts, funds balance, and the transactions that make up each settlement through the Finances API. Together they cover authenticating a seller and reconciling their cash movement, but not changing listings, issuing refunds, or moving money.

### Do both APIs share one set of eBay credentials?

Both use eBay OAuth 2.0 on the same apiz.ebay.com host, but each depends on the specific scopes the user grants. A single authorisation covers both only when the user consents to both the identity profile scope and the finances scopes, so plan the consent screen for the fields you actually need.

### Are these APIs read-only?

Yes. The Identity API exposes a single read of the user profile and the Finances API only lists and summarises payouts, transactions, and balances. Neither can create a listing, issue a refund, or trigger a payout, which makes the pair suited to reporting, reconciliation, and audit workflows.

### In what order should an agent call them?

Confirm the account first with the Identity API's GET /user/, then call the Finances API. Recording the eBay user identifier before pulling payout data keeps every settlement tied to the account it belongs to, which matters when one integration serves many sellers.

### Can I restrict which of these operations my agent may call?

Yes. Because Jentic One is self-hosted, your own rules decide which operations and credentials the agent may use. You can grant only the reads you want, such as the single profile lookup plus specific Finances endpoints, and since every operation is read-only the agent still cannot alter account data or move funds.

### Why is a payout lower than the seller expected?

The Finances API breaks each payout into its underlying transactions, so you retrieve the payout by ID and then list the transactions filtered to it. The refunds, dispute holds, and fees in that breakdown are what reconcile to the lower headline figure.

### Do these APIs cover buyer activity or store listings?

No. They are seller-account and finance focused. Buyer flows, listing management, and order fulfilment live in other eBay APIs with their own scopes, so pair these two when the job is authenticating a seller and reconciling their finances.