The Finances API allows sellers to review and track financial information about their eBay account.
Sellers can view the status of one or more payouts, determine how many transactions have been made within a specific time, determine the amount of fees and charges that have been paid to eBay, and view the total amount of funds available for a payout that have not been processed yet.
See the following topics for more information on using the Finances API :
-
Retrieving Payout Information - The Finances API allows sellers to review and track information relating to seller payouts. They can also view pending funds that have not been distributed through a seller payout.
-
Retrieving Other Monetary Transactional Data - The Finances API allows sellers to review and track information relating to monetary transactions, as well as receive the details and charges associated with a Transfer transaction.
-
Setting up Split Payouts for Mainland China Sellers - When used concurrently with the Account v2 API, sellers in Mainland China can use the Finances API to retrieve split payout information.
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.
Note: The Finances API does not support Team Access. Financial information, such as payouts or transactions, is only returned for the user that makes the call. You cannot use any of the methods in this API to return financial information for another user.
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.