The Finances API is used by sellers to review/track financial information for their eBay account, such payouts to their bank account, loans/repayments, shipping costs, etc.
The information returned is similar to that available under the Payments tab of the Seller Hub in My eBay
Technical overview
The Finances API includes the following methods:
getPayout: This method retrieves information for a specific payout.getPayouts: This method retrieves information for one or more payouts that match the filter criteria specified.getPayoutSummary: This method retrieves aggregated information for payouts that match the filter criteria specified.getTransactions: This method returns information for one or more transactions that match the filter criteria specified.getTransactionSummary: This method returns aggregated information for transactions that match the filter criteria specified.getTransfer: This method returns details for a specified transfer.getSellerFundsSummary: This method returns aggregated information for funds that have not yet been distributed through a seller payout.
Business use cases
Typical use cases for the Finances API include:
- Determine the status of one or more specific payouts.
-
Review and track eBay Seller Capital loan repayments.
Note: eBay Seller Capital is only available in select marketplaces. Refer to Marketplace availability for eBay Seller Capital funding program for current marketplace eligibility.
- Determine how many sales transactions have been made within a specified period.
- Determine the total amount of fees and charges that have been paid to eBay within a specified period.
- Determine the total amount of funds currently available for payout but are not yet being processed.
Finances API requirements and restrictions
The Finances API is not restricted by marketplace or user, and can be considered a "standalone" API. Users are not required to be integrated with any other eBay public APIs in order to use the Finances API.
Important! You should not use any API response or notification, other than the Notification API, as a source to query the Finances API, as this may result in immutable response and system errors due to lack of payment data availability. For example, once your item results in a sale, there could be instances where there may be a lag on when the payment transactions shows up in Finances API as transactions would only show up once the payment has been successfully executed.
Note: Charges and credits for shipping labels purchased with methods other than eBay funds, such as PayPal, are not supported in the Finances API.
Note: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.
Marketplace availability for eBay Seller Capital funding program
eBay Seller Capital funding is currently available in the following eBay marketplaces:
- Germany (EBAY_DE)
- United Kingdom (EBAY_GB)
Retrieving loan repayment transactions is limited to currently supported marketplaces.