finances API1.1.0

getSellerFundsSummary

GET
/seller_funds_summary
This method retrieves all pending funds that have not yet been distibuted through a seller payout.

There are no input parameters for this method. The response payload includes available funds, funds being processed, funds on hold, and also an aggregate count of all three of these categories.

If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content is returned instead.

Input

Resource URI (production)

GET https://apiz.ebay.com/sell/finances/v1/seller_funds_summary

URI parameters

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

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

eBayUser

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
availableFundsAmountThe dollar value in this field represents the total amount of order funds that are available for a payout, but processing for a seller payout has not yet begun. If a seller wants to get more details on sales transactions that have yet to be processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_AVAILABLE_FOR_PAYOUT.

This container is not returned if there are no funds available to be processed for a payout.

Occurrence: Conditional

availableFunds.currencyCurrencyCodeEnumA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

availableFunds.valuestringThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container.

Occurrence: Conditional

fundsOnHoldAmountThe dollar value in this field represents the total amount of order funds on hold. Seller payment holds can occur for different reasons. If a seller wants to get more details on sales transactions where funds are currently on hold, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_ON_HOLD.

This container is not returned if there are no seller payment holds that will eventually be processed for a payout.

Occurrence: Conditional

fundsOnHold.currencyCurrencyCodeEnumA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

fundsOnHold.valuestringThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container.

Occurrence: Conditional

processingFundsAmountThe dollar value in this field represents the total amount of order funds being prepared and processed for a seller payout. If a seller wants to get more details on sales transactions that are being processed, the seller can use the getTransactions method, and use the transactionStatus filter with its value set to FUNDS_PROCESSING.

This container is not returned if there are no funds being processed for a payout.

Occurrence: Conditional

processingFunds.currencyCurrencyCodeEnumA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

processingFunds.valuestringThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container.

Occurrence: Conditional

totalFundsAmountThe dollar value in this field represents the total amount of order funds still due to be distributed to the seller through a seller payout. The dollar value in this field should equal the amounts found in the three other containers.

If there are no pending funds due to the seller through a payout, this container is not returned, and there will not be any response payload at all. Instead, an http status code of 204 - No Content is returned

Occurrence: Conditional

totalFunds.currencyCurrencyCodeEnumA three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with the amount container.

Default: The currency of the authenticated user's country.

Occurrence: Conditional

totalFunds.valuestringThe monetary amount, in the currency specified by the currency field. This field is always returned with the amount container.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
204No Content
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
135000API_FINANCESAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get All Pending Funds

This method retrieves all pending funds that have not yet been distibuted through a seller payout. There are no input parameters for this method.

Input

There are no input parameters for this method.
GET
https://apiz.ebay.com/sell/finances/v1/seller_funds_summary

Output

The output shows the total aggregate amount (totalFunds) of all pending funds that will eventually be distributed to seller's account through a payout, the total amount of available funds (availableFunds) that will get processed, the total amount of funds currently being processed for a pending payout (processingFunds), and funds that are currently on hold (fundsOnHold).