Skip to main content

This type is used by the response payload of the getSellerFundsSummary method. All of the funds returned in getSellerFundsSummary are funds that have not yet been paid to the seller through a seller payout. 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.

Types that use SellerFundsSummaryResponse

Not used by any types.

Call that uses SellerFundsSummaryResponse

Fields

Field
Type
Description
availableFunds
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 will return 0.0 with the appropriate payout currency if there are no funds available to be processed for a payout.
fundsOnHold
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 will return 0.0 with the appropriate payout currency if there are no seller payment holds that will eventually be processed for a payout.
processingFunds
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 will return 0.0 with the appropriate payout currency if there are no funds available to be processed for a payout.
totalFunds
This field represents the total amount of order funds still due to be distributed to the seller through a seller payout. This field should equal the sum of the amounts returned in the following fields:
  • processingFunds
  • availableFunds
  • fundsOnHold

If no payout funds are due to the seller, a 204 - No Content status code will be returned along with an empty payload.

Got thoughts? Click the feedback button – your insights help us improve!