getScheduledPayoutDetails

Note: Payout Details API Version 1.1.0 is only available for testing in the Sandbox environment until May 7, 2012. Until this service becomes available in the Production environment in May, DE and AT sellers can use Payout Details API Version 1.0.0 to retrieve seller payouts. However, the getScheduledPayoutDetails call was not available in Version 1.0.0.

To retrieve all payouts that are scheduled for disbursement from eBay to the seller, use the getScheduledPayoutDetails call.

Request Details

To retrieve all payouts that are scheduled for disbursement from eBay to the seller, use the getScheduledPayoutDetails call. The optional paginationInput container can be used to control the pagination of the result set, including the the maximum number of scheduled payouts returned per page and the page number to retrieve.

Working with the Response

The getScheduledPayoutDetails response provides the seller a detailed look at all scheduled seller payout(s) for the seller. All seller payout information for the order is contained under one or more scheduledPayoutDetail elements. One scheduledPayoutDetail element is returned for each scheduled seller payout. The following are the key containers and fields under the scheduledPayoutDetail element:

estimatedPayoutAmount: this field indicates the expected amount of the seller payout.
estimatedPayoutDate: this timestamp indicates the expected date of the seller payout.
orderDetail: this container contains detailed information about each order tied to the scheduled seller payout, including unique identifiers for the order (order ID, transaction ID(s), and buyer ID), the order amount, and the amount of any refund issued from the seller to the buyer.
payoutAccountDetail: this container consists of the account type to which funds will be sent.
caseFund: this container is returned if there is an eBay Buyer Protection case filed against the eBay order, and includes the case ID and the monetary amount in dispute for the case.
refund: this container is only returned if the seller has issued one or more refunds to the buyer for any of the orders tied to the scheduled seller payout. A separate refund transaction is required for each order line item, and for each refund type. For example, refunding purchase price and refunding shipping are two separate refund transactions.

The paginationOutput container is always returned, even when the caller does not include the paginationInput container in the request. The child fields of the paginationOutput container include the total number of payouts returned based on the input criteria, the number of seller payouts per page, the total pages returned, and the current page number of results.

getScheduledPayoutDetails Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

getScheduledPayoutDetails Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getScheduledPayoutDetailsResponse xmlns="http://www.ebay.com/marketplace/fundstatus/v1/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <paginationOutput> PaginationOutput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
    <totalEntries> int </totalEntries>
    <totalPages> int </totalPages>
  </paginationOutput>
  <scheduledPayoutDetail> ScheduledPayoutDetailType
    <caseFund> CaseFundType
      <caseFundAmount> Amount (double) </caseFundAmount>
      <caseId> CaseIdType
        <id> string </id>
      </caseId>
    </caseFund>
    <!-- ... more caseFund nodes here ... -->
    <estimatedPayoutAmount> Amount (double) </estimatedPayoutAmount>
    <estimatedPayoutDate> dateTime </estimatedPayoutDate>
    <orderDetail> OrderDetailType
      <buyerId> string </buyerId>
      <orderAmount> Amount (double) </orderAmount>
      <orderId> OrderIdType
        <id> string </id>
      </orderId>
      <refundAmount> Amount (double) </refundAmount>
      <transactionDetail> TransactionDetailType
        <itemId> string </itemId>
        <itemTitle> string </itemTitle>
        <transactionId> string </transactionId>
      </transactionDetail>
      <!-- ... more transactionDetail nodes here ... -->
    </orderDetail>
    <!-- ... more orderDetail nodes here ... -->
    <payoutAccountDetail> PayoutAccountDetailType
      <payoutAccountNumber> string </payoutAccountNumber>
      <payoutAccountType> PayoutAccountType (string) </payoutAccountType>
    </payoutAccountDetail>
    <refund> RefundType
      <refundOrderId> OrderType
        <orderId> OrderIdType
          <id> string </id>
        </orderId>
        <transactionDetail> TransactionDetailType
          <itemId> string </itemId>
          <itemTitle> string </itemTitle>
          <transactionId> string </transactionId>
        </transactionDetail>
        <!-- ... more transactionDetail nodes here ... -->
      </refundOrderId>
      <sourceDetails> DebitedSourceType
        <debitedAmount> Amount (double) </debitedAmount>
        <debitedSource> string </debitedSource>
      </sourceDetails>
      <!-- ... more sourceDetails nodes here ... -->
      <totalRefundAmount> Amount (double) </totalRefundAmount>
    </refund>
    <!-- ... more refund nodes here ... -->
  </scheduledPayoutDetail>
  <!-- ... more scheduledPayoutDetail nodes here ... -->
</getScheduledPayoutDetailsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	A token representing the application-level acknowledgement code that indicates the response status. Applicable values: • Failure (out) eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. Inspect the message details and resolve any problems before resubmitting the request. • Success (out) eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result. • Warning (out) The request that triggered the error was processed successfully but with one or more warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request. This field is not returned if the ack value is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Container consisting of detailed information about one error or warning. This container is only returned if an error or warning occurs with the request.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay. • Request (out) An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay. • System (out) Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that caused the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause. If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form. If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem. Applicable values: • Error (out) eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request. • Warning (out) The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this Return, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request.

Call-specific Output Fields

paginationOutput	PaginationOutput	Always	Pagination container consisting of fields that indicate the total number of pages and payouts that match the input criteria, the number of payouts per page, and the current page number being viewed. This container is returned regardless of whether the paginationInput container is used in the request.
paginationOutput .entriesPerPage	int	Always	The number of payouts returned per page. This value is set in the paginationInput.entriesPerPage field in the request. This field is always returned with the paginationOutput container.
paginationOutput.pageNumber	int	Always	The page number currently being viewed. The total number of result pages is shown in the totalPages field. This field is always returned with the paginationOutput container.
paginationOutput.totalEntries	int	Always	This value indicates the total number of seller payouts that exist based on the current input criteria. Once this value is known, the caller may want to considering tweaking the paginationInput fields and making another call. This field is always returned with the paginationOutput container.
paginationOutput.totalPages	int	Always	This value indicates the total number of result pages that exist based on the current input criteria. If totalPages is more than 1, multiple calls must be made to view all payout results, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call. This field is always returned with the paginationOutput container.
scheduledPayoutDetail	ScheduledPayoutDetailType	Conditionally, repeatable: [0..*]	Root container consisting of detailed information for each scheduled seller payout.
scheduledPayoutDetail.caseFund	CaseFundType	Conditionally, repeatable: [0..*]	Container consisting of information on an eBay Buyer Protection case. This container is only returned if there is an eBay Buyer Protection case or dispute filed against the order. There can be multiple caseFund containers returned if there is more than one case filed against the order. For more information on eBay Buyer Protection cases, see the Resolution Case Management API documentation.
scheduledPayoutDetail.caseFund .caseFundAmount	Amount (double)	Conditionally	The monetary amount involved in the eBay Buyer Protection case between the buyer and seller. This field is always returned with the caseFund container.
scheduledPayoutDetail.caseFund .caseId	CaseIdType	Conditionally	The unique identifier of the eBay Buyer Protection case. This field is always returned with the caseFund container.
scheduledPayoutDetail.caseFund .caseId.id	string	Conditionally	The unique identifier of an eBay Buyer Protection case. This field is always returned with the caseId container. Max length: 38.
scheduledPayoutDetail .estimatedPayoutAmount	Amount (double)	Conditionally	This dollar value indicates the expected amount of the seller payout. This field is always returned with the scheduledPayoutDetail container.
scheduledPayoutDetail .estimatedPayoutDate	dateTime	Conditionally	This dateTime value indicates the expected date of the seller payout. This field is always returned with the scheduledPayoutDetail container.
scheduledPayoutDetail .orderDetail	OrderDetailType	Conditionally, repeatable: [1..*]	Container consisting of detailed information about an eBay order that is scheduled to receive one or more seller payouts. The orderDetail container is always returned with the orderPayoutDetailType container.
scheduledPayoutDetail .orderDetail.buyerId	string	Conditionally	The eBay user ID of the order's buyer. .
scheduledPayoutDetail .orderDetail.orderAmount	Amount (double)	Always	This dollar value indicates the total amount of the order. This field is always returned with the orderDetail container.
scheduledPayoutDetail .orderDetail.orderId	OrderIdType	Always	Container consisting of the unique identifier of an eBay order. This container is always returned with the orderDetail container.
scheduledPayoutDetail .orderDetail.orderId.id	string	Always	A unique identifier of an eBay order. This field will accept an eBay-generated OrderID value or an OrderLineItemID value, which is a concatenation of ItemID and TransactionID with a hyphen separating these two IDs. See the Trading API documentation for more information on eBay orders.
scheduledPayoutDetail .orderDetail.refundAmount	Amount (double)	Conditionally	The monetary amount of a seller's refund to the buyer. This field is only returned if a full or partial refund was issued by the seller to the buyer.
scheduledPayoutDetail .orderDetail.transactionDetail	TransactionDetailType	Always, repeatable: [1..*]	Container consisting of identifying information for each line item in the order. A transactionDetail container is returned for each order line item that is enabled for the new eBay payment process.
scheduledPayoutDetail .orderDetail.transactionDetail .itemId	string	Always	Unique identifier of an eBay item listing.
scheduledPayoutDetail .orderDetail.transactionDetail .itemTitle	string	Always	The title of an eBay item listing.
scheduledPayoutDetail .orderDetail.transactionDetail .transactionId	string	Always	Unique identifier of an eBay order line item.
scheduledPayoutDetail .payoutAccountDetail	PayoutAccountDetailType	Conditionally	This container consists of the account type that the seller has selected as his/her default payout account. This container is always returned with the scheduledPayoutDetail container.
scheduledPayoutDetail .payoutAccountDetail .payoutAccountNumber	string	Conditionally	The account number of the seller's payout account. This information will only be returned to the seller.
scheduledPayoutDetail .payoutAccountDetail .payoutAccountType	PayoutAccountType (string)	Always	The account type selected by the seller to which eBay will distribute seller payouts.
scheduledPayoutDetail.refund	RefundType	Conditionally, repeatable: [0..*]	Container consisting of detailed information on a seller's refund to the buyer. This container is only returned if the seller has issued one or more refunds to the buyer for the order. A separate refund transaction is required for each order line item, and for each refund type. For example, refunding purchase price and refunding shipping are two separate refund transactions.
scheduledPayoutDetail.refund .refundOrderId	OrderType	Conditionally	The unique identifier of the order in which a refund was issued to the buyer. This field is always returned with the refund container.
scheduledPayoutDetail.refund .refundOrderId.orderId	OrderIdType	Conditionally	Container consisting of the unique identifier of an eBay order. This container is always returned with the refundOrderId container.
scheduledPayoutDetail.refund .refundOrderId.orderId.id	string	Always	A unique identifier of an eBay order. This field will accept an eBay-generated OrderID value or an OrderLineItemID value, which is a concatenation of ItemID and TransactionID with a hyphen separating these two IDs. See the Trading API documentation for more information on eBay orders.
scheduledPayoutDetail.refund .refundOrderId .transactionDetail	TransactionDetailType	Conditionally, repeatable: [0..*]	Container consisting of identifying information for the order line item on which one or more refunds were issued to the buyer. One transactionDetail container will be returned for each line item in the order receiving refund(s). At least one transactionDetail container is always returned with the refundOrderId container.
scheduledPayoutDetail.refund .refundOrderId .transactionDetail.itemId	string	Always	Unique identifier of an eBay item listing.
scheduledPayoutDetail.refund .refundOrderId .transactionDetail.itemTitle	string	Always	The title of an eBay item listing.
scheduledPayoutDetail.refund .refundOrderId .transactionDetail .transactionId	string	Always	Unique identifier of an eBay order line item.
scheduledPayoutDetail.refund .sourceDetails	DebitedSourceType	Conditionally, repeatable: [1..*]	Container consisting of a seller's account type, account number, and monetary amount debited to the account to satisfy a refund to the buyer. This container is always returned with the refund container.
scheduledPayoutDetail.refund .sourceDetails.debitedAmount	Amount (double)	Conditionally	This dollar value indicates the monetary amount debited for the seller's account (defined in the debitedSource) field. This field is always returned with the sourceDetails container.
scheduledPayoutDetail.refund .sourceDetails.debitedSource	string	Conditionally	This string value indicates the type of seller's account that is debited for the refund. This field is always returned with the sourceDetails container.
scheduledPayoutDetail.refund .totalRefundAmount	Amount (double)	Conditionally	This dollar value indicates the total amount of one or more refunds issued by the seller to the buyer for the order. This field is always returned with the refund container.

getScheduledPayoutDetails Samples

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

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic

Retrieves details for all scheduled seller payouts for a seller.

Description

This getScheduledPayoutDetails call sample returns details for all scheduled seller payouts for a seller.

The caller must be authenticated to make this call.

Input

A seller listing on the German (DE) site wants to retrieve details for all scheduled seller payouts due to be disbursed by eBay to his seller account.

The seller uses the optional paginationInput container, and sets the seller payouts per page at '50', and '1' as the page number to return.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalents.

<?xml version="1.0" encoding="utf-8"?>
<getScheduledPayoutDetailsRequest xmlns:soap="http://www.ebay.com/marketplace/fundstatus/v1/services">
    <paginationInput>
       <pageNumber>1</pageNumber>
       <entriesPerPage>50</entriesPerPage>
    </paginationInput>
</getScheduledPayoutDetailsRequest>

Output

One seller payout is retrieved for the seller. This seller payout includes two single line item orders purchased by the same buyer - ecafuser131241715845925. The total amount for Order #190002506035-7580604009 is 3.00 EUR, and the total amount for Order #190002506051-7580611009 is 2.00 EUR, for a total payout of 5.00 EUR, which is indicated by the value returned in the estimatedPayoutAmount field. The estimated payout amount is scheduled to be distributed to the seller's PayPal account.

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
  <getScheduledPayoutDetailsResponse xmlns="http://www.ebay.com/marketplace/fundstatus/v1/services">
     <ack>Success</ack>
     <version>1.1.0</version>
     <timestamp>2012-04-02T21:53:24.569Z</timestamp>
     <scheduledPayoutDetail>
        <estimatedPayoutDate>2012-04-05T00:00:00.569-07:00</estimatedPayoutDate>
        <estimatedPayoutAmount currencyId="EUR">5.0</estimatedPayoutAmount>
        <payoutAccountDetail>
           <payoutAccountType>PAYPAL</payoutAccountType>
           <payoutAccountNumber>a***p@paypal.com</payoutAccountNumber>
        </payoutAccountDetail>
        <orderDetail>
           <orderId>
              <id>190002506035-7580604009</id>
           </orderId>
           <orderAmount currencyId="EUR">3.0</orderAmount>
           <buyerId>ecafuser131241715845925</buyerId>
           <transactionDetail>
              <itemId>190002506035</itemId>
              <itemTitle>Fixed Price Single Quantity</itemTitle>
              <transactionId>7580604009</transactionId>
           </transactionDetail>
        </orderDetail>
        <orderDetail>
           <orderId>
              <id>190002506051-7580611009</id>
           </orderId>
           <orderAmount currencyId="EUR">2.0</orderAmount>
           <buyerId>ecafuser131241772943625</buyerId>
           <transactionDetail>
              <itemId>190002506051</itemId>
              <itemTitle>Fixed Price Single Quantity</itemTitle>
              <transactionId>7580611009</transactionId>
           </transactionDetail>
        </orderDetail>
     </scheduledPayoutDetail>
     <paginationOutput>
        <pageNumber>1</pageNumber>
        <entriesPerPage>50</entriesPerPage>
        <totalPages>1</totalPages>
        <totalEntries>1</totalEntries>
     </paginationOutput>
  </getScheduledPayoutDetailsResponse>
   </soapenv:Body>
</soapenv:Envelope>

getScheduledPayoutDetails Change History

Version	Description
1.1.0 2012-04-07	(added) New call.

User-Contributed Notes

paginationInput	PaginationInput	Optional	Controls the pagination of the result set, including the the maximum number of scheduled payouts returned per page and the page number to retrieve.
paginationInput.entriesPerPage	int	Optional	Specifies the maximum number of seller payouts to return in one page of results in the response. If the number of seller payouts that can be returned is less than the value in entriesPerPage, then the lower number is returned. This field value defaults to 50 if not specified. Min: 1. Max: 50. Default: 50.
paginationInput.pageNumber	int	Optional	Specifies which page of seller payouts to return in the response. The total number of result pages is determined by the total number of seller payouts matching the input criteria divided by the number of seller payouts to display in each page. The total number of seller payouts is returned in the paginationOutput.totalEntries field of the getPayoutDetails response. The cases to display per page is set with the paginationInput.entriesPerPage field. If there are multiple result pages returned, subsequent calls can be made with all of the same input parameters, except for the pageNumber field, which is incremented by a value of 1 each time so that each subsequent page may be viewed and/or handled. This field value defaults to 1 if not specified. Min: 1. Default: 1.

Payout Details API Call Reference Version 1.1.0