eBay Finances Data Source

The eBay Finances connector enables you to ingest payout records, monetary transactions, fund transfers, and seller funds summaries from eBay's managed payments platform. Follow the instructions below to create a new data flow that ingests data from an eBay Finances source in Nexla.

eBay Finances

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the eBay Finances connector tile from the list of available connectors. 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.

3. In Nexla, eBay Finances data sources can be created using pre-built endpoint templates, which expedite source setup for common eBay Finances API endpoints. Each template is designed specifically for the corresponding eBay Finances endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   eBay Finances sources can also be configured manually, allowing you to ingest data from eBay Finances endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common eBay Finances API endpoints. Each template is designed specifically for the corresponding endpoint, making data source setup easy and efficient.

Endpoint Settings

• 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

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.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched and displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

eBay Finances data sources can be manually configured to ingest data from any valid eBay Finances API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by the pre-built templates or when you need custom API configurations, such as adding additional query string filter parameters.

With manual configuration, you can also create more complex eBay Finances sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the eBay Finances API from the Method pulldown menu. All eBay Finances API endpoints use:

   • GET: For retrieving financial data from the API. All eBay Finances endpoints use the GET method.

API Endpoint URL

3. Enter the URL of the eBay Finances API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

   Common eBay Finances 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}'}
   • Seller Funds Summary: https://apiz.ebay.com/sell/finances/v1/seller_funds_summary

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that adapt to different time periods or data requirements. This is particularly useful for eBay Finances endpoints that accept date range filter parameters.

Date/time macros are useful for eBay Finances endpoints that accept filter query parameters with date ranges, such as retrieving transactions or payouts from a specific time window. For example, you can use macros to automatically retrieve the previous day's transactions on each run.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For eBay Finances, this is useful for dynamically constructing endpoint URLs that include IDs obtained from a prior step (for example, using payout IDs returned by the List Payouts endpoint to individually retrieve full payout details).

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by the API endpoint is needed, you can designate which part of the response should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful for list endpoints that wrap result arrays inside a parent object.

For example, the eBay Finances getPayouts endpoint returns a JSON response with a top-level payouts array containing the individual payout records. By entering the path $.payouts[*], Nexla treats each element of the array as a separate record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.payouts[*] to access the payouts array, or $.transactions[*] to access the transactions array).
  Path to Data Example:

  For the eBay Finances List Payouts endpoint, the API response wraps payout records in a top-level array named payouts. Enter $.payouts[*] as the path to data so that Nexla treats each payout as an individual record. For the List Transactions endpoint, use $.transactions[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content and format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. For eBay Finances list endpoints, the response typically includes pagination metadata (such as total, offset, and limit) alongside the data array. This metadata can be preserved with each record when needed for auditing or tracking purposes.

Metadata paths are particularly useful for preserving API response context like pagination counts, request timestamps, or summary statistics that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). The eBay Finances API accepts standard HTTP headers for content negotiation or API marketplace compliance.

  You do not need to include the Authorization header in the request headers. Nexla automatically injects the OAuth bearer token from the configured credential into each API call. Common headers like Content-Type and Accept are also handled automatically.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched and displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, 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.