eBay Finances

eBay Finances is part of eBay's managed payments platform, giving sellers programmatic access to their financial data. The Finances API retrieves payout details, monetary transaction records, fund transfers, and a summary of available, processing, and on-hold funds. Mirroring the Payments tab in Seller Hub, it enables automated financial reporting, reconciliation, and cash-flow monitoring.

Power end-to-end data operations for your eBay Finances API with Nexla. Our bi-directional eBay Finances connector is purpose-built for eBay Finances, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to eBay Finances or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your eBay Finances workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

The eBay Finances API uses eBay's OAuth 2.0 authorization-code (3-legged) flow, which means sellers must explicitly grant your registered eBay application permission to access their financial data. Before creating a credential in Nexla, complete the steps below to register an application in the eBay Developer Program and obtain the required OAuth credentials.

Register an Application in the eBay Developer Program

1. Sign in to the eBay Developer Program at developer.ebay.com using your eBay account credentials. If you do not already have a Developer Program account, click Join the eBay Developers Program to register for free.

2. After signing in, navigate to My Account in the top navigation bar and select Application Keys from the dropdown menu.

3. On the Application Keys page, click the Create a keyset button to begin creating a new application keyset.

4. Enter a descriptive title for your application in the Application Title field (for example, Nexla Financial Data Integration).

5. Select Production as the environment for connecting to live seller data. Select Sandbox only when testing with non-live credentials.

6. Click Continue to create the keyset. eBay will generate the following credentials for your application:

   • App ID (Client ID) — The public identifier for your application. This value is used as the OAuth client ID in Nexla.

   • Cert ID (Client Secret) — A confidential value used to authenticate token requests. Treat this like a password and never share it publicly or include it in source code repositories.

   • Dev ID — A developer-level identifier tied to your Developer Program account. This value is not required for the Nexla credential.

7. Copy and store the App ID and Cert ID values securely, as you will need them when configuring the credential in Nexla.

Configure a RuName (Redirect URL)

The 3-legged OAuth flow requires an eBay RuName (Redirect URL Name), which is an eBay-assigned identifier for the redirect URI that eBay uses to return the authorization code after a seller approves the request.

1. From the Application Keys page, click User Tokens (or navigate to Get a Token from eBay via Your Application) for your Production keyset.

2. In the eBay Redirect URL section, click Add eBay Redirect URL.

3. Enter a display title and the redirect URI provided by your Nexla OAuth integration. Nexla handles the OAuth callback automatically; refer to your Nexla account settings or Nexla support for the correct redirect URI value.

4. Copy the generated RuName value and store it for reference. eBay uses this value to validate that redirect requests originate from your registered application.

Confirm the sell.finances OAuth Scope

The eBay Finances API requires the https://api.ebay.com/oauth/api_scope/sell.finances OAuth scope. This scope grants read access to the seller's payout, transaction, transfer, and funds-summary data within eBay's managed payments platform.

1. On the Application Keys page, click OAuth Scopes next to your Production keyset to view the scopes assigned to your application.

2. Verify that https://api.ebay.com/oauth/api_scope/sell.finances is listed. If it is not present, update the keyset configuration to include this scope before proceeding.

Only sellers enrolled in eBay managed payments can use the Finances API. A seller who has not yet been enrolled in managed payments will not be able to complete the OAuth authorization step. For additional details, see the eBay Finances API Overview in the eBay Developers Program documentation.

Authenticate

Credentials required

Authenticate via eBay's 3-legged OAuth 2.0 authorization-code flow. Sellers grant the app access to their financial data; the Finances API requires the sell.finances scope.

Field	Required	Secret	Description
Authorization URL	No	No	The eBay endpoint where users authorize the application. Use https://auth.ebay.com/oauth2/authorize for production.
Client ID (App ID)	Yes	Yes	The eBay App ID (also called client_id) for the registered keyset.
Access Scope	No	No	Space-separated list of OAuth scopes. Finances API requires https://api.ebay.com/oauth/api_scope/sell.finances
Token URL	No	No	The eBay token endpoint. Use https://api.ebay.com/identity/v1/oauth2/token for production.
Client ID for Token URL	No	Yes	The eBay App ID re-used for the token exchange. Bound to the Authorization URL Client ID.
Client Secret (Cert ID)	Yes	Yes	The eBay Cert ID (also called client_secret) used to authenticate token requests.

Create a credential in Nexla

1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Confirm or enter the eBay authorization endpoint in the Authorization URL field. For the production environment, this value is pre-filled as:

   https://auth.ebay.com/oauth2/authorize

   This is the eBay endpoint where the seller will be redirected to sign in and grant permission to your application. Use the sandbox authorization URL (https://auth.sandbox.ebay.com/oauth2/authorize) only when testing with sandbox credentials.

4. Enter your eBay App ID in the Client ID (App ID) field. This is the public identifier generated when you created the application keyset in the eBay Developer Program.

5. Confirm the OAuth scope in the Access Scope field. The required scope for the eBay Finances API is pre-filled as:

   https://api.ebay.com/oauth/api_scope/sell.finances

   If your application requires additional eBay OAuth scopes, add them as a space-separated list in this field.

6. Confirm or enter the eBay token endpoint in the Token URL field. For the production environment, this value is pre-filled as:

   https://api.ebay.com/identity/v1/oauth2/token

   This is the endpoint where Nexla exchanges the authorization code for an access token and refresh token after the seller completes the authorization step. Nexla automatically refreshes tokens before they expire, so no manual token management is required. Use the sandbox token URL (https://api.sandbox.ebay.com/identity/v1/oauth2/token) only when using sandbox credentials.

7. Enter your eBay Cert ID in the Client Secret (Cert ID) field. This is the confidential credential generated alongside your App ID in the eBay Developer Program. The Cert ID authenticates your application during the token exchange request.

   Important

   The Cert ID (Client Secret) is used to access sensitive seller financial data. Never share this value publicly, include it in source code repositories, or expose it in client-side code. Store it securely in a secrets manager or credential vault.

8. After entering all credential details, Nexla will initiate the OAuth authorization flow. The seller whose financial data will be accessed must sign in to their eBay account on the eBay authorization page and click Agree to grant the sell.finances scope to your application. Upon successful authorization, Nexla will automatically exchange the authorization code for access and refresh tokens.

9. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the eBay Finances connector tile, then select the credential that will be used to connect to the eBay Finances API, and click Next; or, create a new eBay Finances credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common eBay Finances API endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Payouts

Retrieves a list of seller payouts that match optional filter criteria. Use this endpoint to pull paginated payout records for financial reconciliation, payout history reporting, or cash-flow analysis. Each payout represents a disbursement of funds from eBay to the seller's bank account.

• This endpoint uses offset-based pagination and automatically retrieves all matching payouts in pages of up to 200 records. No additional pagination configuration is required.
• No required parameters are needed to retrieve all recent payouts. The endpoint returns payouts for the authenticated seller account.
• Each payout record includes the payout ID, amount, currency, status, payout date, and the bank account to which the payout was sent.

The data returned by this endpoint corresponds to what sellers see in the Payments tab of eBay Seller Hub. For additional details about payout fields and filtering options, see the getPayouts reference in the eBay Developers Program documentation.

Get Payout

Retrieves detailed information for a single payout identified by its unique payout ID. Use this endpoint when you need to look up the complete details of a specific disbursement, such as verifying a payout amount or status for a particular settlement date.

• Enter the unique identifier of the payout to retrieve in the Payout ID field. This required field accepts a single string value.

  • Payout IDs can be obtained from the List Payouts endpoint, which returns all recent payouts for the seller account along with their corresponding IDs.
  • Payout IDs are also visible in the Payments tab of eBay Seller Hub under the seller's payout history.
• The response includes the full payout record for the specified payout ID, including amount, currency, payout status, payout date, and associated transaction summary information.

For additional details about the response fields, see the getPayout reference in the eBay Developers Program documentation.

Get Payout Summary

Retrieves cumulative summary values for payouts, including total count and aggregate dollar value grouped by payout status. Use this endpoint for high-level financial dashboards or to quickly assess the volume and value of payouts in a given state without retrieving individual payout records.

• No required parameters are needed to retrieve the payout summary. The endpoint returns aggregated payout data for the authenticated seller account.
• The response includes cumulative payout counts and total amounts broken down by payout status (for example, initiated, retryable, succeeded, or reversed).

For additional details about the response fields, see the getPayoutSummary reference in the eBay Developers Program documentation.

List Transactions

Retrieves monetary transactions for the seller's account. Monetary transactions include buyer payments for orders, refunds issued for returns or cancelled orders, and credits applied by eBay. Use this endpoint for detailed transaction-level reporting, order reconciliation, or accounting integrations.

• This endpoint uses offset-based pagination and retrieves transactions in pages of up to 1,000 records. All matching transactions are automatically fetched across pages.
• No required parameters are needed to retrieve all recent transactions. The endpoint returns transactions for the authenticated seller account.
• Each transaction record includes the transaction ID, transaction type, amount, currency, transaction date, order details, and the payout ID to which the transaction was applied.

Transaction data includes all monetary activity on the seller account, not just sales. Refunds, adjustments, and eBay-issued credits are also included. For additional details about transaction types and fields, see the getTransactions reference in the eBay Developers Program documentation.

Get Transaction

Retrieves detailed information for a single monetary transaction identified by its unique transaction ID. Use this endpoint when you need the complete record for a specific payment, refund, or adjustment—for example, when reconciling a specific order line item or investigating a disputed charge.

• Enter the unique identifier of the transaction to retrieve in the Transaction ID field. This required field accepts a single string value.

  • Transaction IDs can be obtained from the List Transactions endpoint, which returns all recent transactions for the seller account along with their corresponding IDs.
  • Transaction IDs are also available in the order and payment detail pages within eBay Seller Hub.
• The response includes the full transaction record for the specified ID, including transaction type, amount, associated order information, and the payout it was applied to.

For additional details about the response fields, see the getTransaction reference in the eBay Developers Program documentation.

Get Transaction Summary

Retrieves cumulative summary values for monetary transactions matching optional filter criteria. Use this endpoint for high-level financial reporting that shows aggregate transaction counts and amounts by transaction type or status, without retrieving individual transaction records.

• No required parameters are needed to retrieve the transaction summary. The endpoint returns aggregated transaction data for the authenticated seller account.
• The response includes cumulative transaction counts and total amounts broken down by transaction type (for example, sale, refund, dispute, or credit).

For additional details about the response fields, see the getTransactionSummary reference in the eBay Developers Program documentation.

Get Transfer

Retrieves detailed information for a specific fund-transfer transaction identified by its unique transfer ID. A transfer represents a movement of funds between eBay and the seller's account that is not associated with a standard buyer-seller transaction—for example, a fee collection or a manual adjustment by eBay.

• Enter the unique identifier of the fund transfer to retrieve in the Transfer ID field. This required field accepts a single string value.

  • Transfer IDs are associated with specific fund movements on the seller account and can be found in the eBay Seller Hub payment activity or obtained from eBay customer support for specific transactions.
• The response includes the full transfer record for the specified transfer ID, including the transfer amount, currency, transfer date, transfer type, and the funding source or destination involved.

For additional details about the response fields, see the getTransfer reference in the eBay Developers Program documentation.

Get Seller Funds Summary

Retrieves a real-time summary of the seller's current fund balances across all managed-payments states. Use this endpoint to monitor available funds ready for payout, funds currently being processed, and funds on hold due to disputes or compliance holds—providing an instant snapshot of cash position on the eBay platform.

• No required parameters are needed to retrieve the funds summary. The endpoint returns the current funds snapshot for the authenticated seller account.

• The response includes fund balances in the following states:

  • Available funds — Funds that have been settled and are available for payout to the seller's bank account.
  • Processing funds — Funds from recent sales or adjustments currently being processed before becoming available.
  • Funds on hold — Funds withheld due to open disputes, return requests, or account-level holds.

For additional details about the response fields, see the getSellerFundsSummary reference in the eBay Developers Program documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

eBay Finances data sources can also be manually configured to ingest data from any valid eBay Finances API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

All eBay Finances endpoints use the GET method. Common endpoint base URLs include List Payouts (https://apiz.ebay.com/sell/finances/v1/payout), Get Payout by ID (https://apiz.ebay.com/sell/finances/v1/payout/{'{payout_id}'}), Payout Summary (https://apiz.ebay.com/sell/finances/v1/payout_summary), List Transactions (https://apiz.ebay.com/sell/finances/v1/transaction), Get Transaction by ID (https://apiz.ebay.com/sell/finances/v1/transaction/{'{transaction_id}'}), Transaction Summary (https://apiz.ebay.com/sell/finances/v1/transaction_summary), Get Transfer by ID (https://apiz.ebay.com/sell/finances/v1/transfer/{'{transfer_id}'}), and Seller Funds Summary (https://apiz.ebay.com/sell/finances/v1/seller_funds_summary). List endpoints wrap results in a top-level array, so set the path to data to $.payouts[*] for payouts or $.transactions[*] for transactions; pagination metadata such as total, offset, and limit can be preserved via the Path to Metadata in Response field. You do not need to include the Authorization header — Nexla automatically injects the OAuth bearer token from the configured credential.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new eBay Finances data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.