getOrderPayoutDetails

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 should use Payout Details API Version 1.0.0 to retrieve seller payouts. Fields that are only available in 1.1.0 Version are called out in this documentation.

To retrieve seller payout information based on a specific eBay order ID, use the getOrderPayoutDetails call. A single seller payout may encompass multiple orders, and if this is the case, seller payout information and order-specific information is returned for each order. Also, depending on the dollar value of the order, one order may have multiple seller payouts.

Request Details

To retrieve seller payout information based on a specific eBay order ID, use the getOrderPayoutDetails call. A valid eBay order ID is required to be passed into the orderId.id field.

This call will fail if an invalid eBay order ID is passed in. An error message will be returned if the order is more than 90 days old, or if a seller payout has yet to be made on the order. The caller must be authenticated to make this call.

Working with the Response

The getOrderPayoutDetails response provides the seller a detailed look at the seller payout(s) for the specified eBay order ID. All seller payout information for the order is contained under one or more payoutDetail containers. One payoutDetail container is returned for each seller payout related to the order. The following are the key containers and fields under the payoutDetail element:

actualPayoutAmount: this field indicates the total amount of the seller payout paid to, or due to be paid to the seller.
payoutStatus: this field indicates the status of the seller's payout. The two possible values are PaidOut (funds are in seller's account) or PayoutSent (funds are en route to the seller's account).
payoutDate: this timestamp indicates the date and time when the seller payout was made by eBay to the seller's account.
orderPayoutDetailType: this container contains detailed information about each order tied to the seller payout, including unique identifiers for the order (order ID, transaction ID(s), and buyer ID), the order amount, the amount of any seller refunds to the buyer, and a flag to indicate if there are multiple seller payouts associated with the order.
payoutAccountDetail: this container consists of the account type and number of the seller's account 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 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. Note that the refund container is not yet available in the Production environment.

getOrderPayoutDetails 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).

getOrderPayoutDetails 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"?>
<getOrderPayoutDetailsResponse 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 -->
  <payoutDetail> PayoutDetailType
    <actualPayoutAmount> Amount (double) </actualPayoutAmount>
    <caseFund> CaseFundType
      <caseFundAmount> Amount (double) </caseFundAmount>
      <caseId> CaseIdType
        <id> string </id>
      </caseId>
    </caseFund>
    <!-- ... more caseFund nodes here ... -->
    <orderPayoutDetailType> OrderPayoutDetailType
      <multiplePayouts> boolean </multiplePayouts>
      <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>
      <orderPayoutAmount> Amount (double) </orderPayoutAmount>
    </orderPayoutDetailType>
    <!-- ... more orderPayoutDetailType nodes here ... -->
    <payoutAccountDetail> PayoutAccountDetailType
      <payoutAccountNumber> string </payoutAccountNumber>
      <payoutAccountType> PayoutAccountType (string) </payoutAccountType>
    </payoutAccountDetail>
    <payoutDate> dateTime </payoutDate>
    <payoutId> string </payoutId>
    <payoutStatus> PayoutStatusType </payoutStatus>
    <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 ... -->
  </payoutDetail>
  <!-- ... more payoutDetail nodes here ... -->
</getOrderPayoutDetailsResponse>

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

payoutDetail	PayoutDetailType	Always, repeatable: [1..*]	Container consisting of detailed information on the seller payout(s) associated with the order identified by the orderId.id value in the request.
payoutDetail .actualPayoutAmount	Amount (double)	Always	The payout amount to the seller. This value may be less than the order amount if the seller issued a partial refund to the buyer.
payoutDetail.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 (eBP cases are filed at the order line item level). For more information on eBay Buyer Protection cases, see the Resolution Case Management API documentation.
payoutDetail.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.
payoutDetail.caseFund.caseId	CaseIdType	Conditionally	The unique identifier of the eBay Buyer Protection case. This field is always returned with the caseFund container.
payoutDetail.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.
payoutDetail .orderPayoutDetailType	OrderPayoutDetailType	Always, repeatable: [1..*]	Container consisting of detailed seller payout information for an eBay order.
payoutDetail .orderPayoutDetailType .multiplePayouts	boolean	Always	A flag that indicates whether or not an eBay order has multiple payouts to the seller. A 'true' value indicates that the order has multiple payouts. This field is always returned with orderPayoutDetailType container.
payoutDetail .orderPayoutDetailType .orderDetail	OrderDetailType	Always	Container consisting of detailed information about an eBay order that has either received, or is scheduled to receive one or more seller payouts. The orderDetail container is always returned with the orderPayoutDetailType container.
payoutDetail .orderPayoutDetailType .orderDetail.buyerId	string	Conditionally	The eBay user ID of the order's buyer. .
payoutDetail .orderPayoutDetailType .orderDetail.orderAmount	Amount (double)	Always	This dollar value indicates the total amount of the order. This field is always returned with the orderDetail container.
payoutDetail .orderPayoutDetailType .orderDetail.orderId	OrderIdType	Always	Container consisting of the unique identifier of an eBay order. This container is always returned with the orderDetail container.
payoutDetail .orderPayoutDetailType .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.
payoutDetail .orderPayoutDetailType .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.
payoutDetail .orderPayoutDetailType .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.
payoutDetail .orderPayoutDetailType .orderDetail.transactionDetail .itemId	string	Always	Unique identifier of an eBay item listing.
payoutDetail .orderPayoutDetailType .orderDetail.transactionDetail .itemTitle	string	Always	The title of an eBay item listing.
payoutDetail .orderPayoutDetailType .orderDetail.transactionDetail .transactionId	string	Always	Unique identifier of an eBay order line item.
payoutDetail .orderPayoutDetailType .orderPayoutAmount	Amount (double)	Always	This dollar value indicates the total payout amount for the order.
payoutDetail .payoutAccountDetail	PayoutAccountDetailType	Always	Container consisting of the seller's account type and account number.
payoutDetail .payoutAccountDetail .payoutAccountNumber	string	Conditionally	The account number of the seller's payout account. This information will only be returned to the seller.
payoutDetail .payoutAccountDetail .payoutAccountType	PayoutAccountType (string)	Always	The account type selected by the seller to which eBay will distribute seller payouts.
payoutDetail.payoutDate	dateTime	Always	Timestamp indicating the date and time when the payout was made to the seller.
payoutDetail.payoutId	string	Always	The unique identifier of a seller payout.
payoutDetail.payoutStatus	PayoutStatusType	Always	Enumeration value indicating the status of the payout to the seller. Applicable values: • PaidOut (out) This value indicates that eBay has disbursed the payout and the funds have been deposited in the seller's account. • PayoutSent (out) This value indicates that eBay has disbursed the payout and the funds are en route to the seller's account.
payoutDetail.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.
payoutDetail.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.
payoutDetail.refund .refundOrderId.orderId	OrderIdType	Conditionally	Container consisting of the unique identifier of an eBay order. This container is always returned with the refundOrderId container.
payoutDetail.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.
payoutDetail.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.
payoutDetail.refund .refundOrderId .transactionDetail.itemId	string	Always	Unique identifier of an eBay item listing.
payoutDetail.refund .refundOrderId .transactionDetail.itemTitle	string	Always	The title of an eBay item listing.
payoutDetail.refund .refundOrderId .transactionDetail .transactionId	string	Always	Unique identifier of an eBay order line item.
payoutDetail.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.
payoutDetail.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.
payoutDetail.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.
payoutDetail.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.

getOrderPayoutDetails 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 seller payout details based on a specific order ID.

Description

This getOrderPayoutDetails call sample returns seller payout details based on a single line item eBay order.

Input

A seller listing on the German (DE) site wants to retrieve seller payout details for an order. The order ID is 290006116171-7740091019.

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

<?xml version="1.0" encoding="utf-8"?>
<getOrderPayoutDetailsRequest xmlns:soap="http://www.ebay.com/marketplace/fundstatus/v1/services">
    <orderId>
       <id>290006116171-7740091019</id>
    </orderId>
</getOrderPayoutDetailsRequest>

Output

The seller payout ID associated with the order 290006116171-7740091019 is 3228809. In addition to order 290006116171-7740091019, seller payout 3228809 is also the payout for order 6137582019 (a combined payment order) and order 290006116174-7740092019. All three orders have different buyers. Seller payout 3228809 is the only seller payout for all three orders, hence the multiplePayouts field is false for all three orders.

The total payout amount for the three orders is $260.00. The seller payout was 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"?>
<getOrderPayoutDetailsResponse xmlns:soap="http://www.ebay.com/marketplace/fundstatus/v1/services">
   <ack>Success</ack>
   <version>1.0.0</version>
   <timestamp>2011-08-14T07:14:59.461Z</timestamp>
   <payoutDetail>
      <payoutId>3228809</payoutId>
      <actualPayoutAmount currencyId="EUR">260.0</actualPayoutAmount>
      <payoutDate>2011-07-02T00:00:00.000-07:00</payoutDate>
      <payoutStatus>PaidOut</payoutStatus>
      <payoutAccountDetail>
         <payoutAccountType>PAYPAL</payoutAccountType>
         <payoutAccountNumber>a***8@paypal.com</payoutAccountNumber>
      </payoutAccountDetail>
      <orderPayoutDetailType>
         <orderDetail>
            <orderId>
               <id>290006116171-7740091019</id>
            </orderId>
            <orderAmount currencyId="EUR">30.0</orderAmount>
            <buyerId>1012075200</buyerId>
            <transactionDetail>
               <transactionId>7740091019</transactionId>
               <itemId>290006116171</itemId>
               <itemTitle>Fixed Price Single Quantity</itemTitle>
            </transactionDetail>
         </orderDetail>
         <multiplePayouts>false</multiplePayouts>
         <orderPayoutAmount currencyId="EUR">30.0</orderPayoutAmount>
      </orderPayoutDetailType>
      <orderPayoutDetailType>
         <orderDetail>
            <orderId>
               <id>6137582019</id>
            </orderId>
            <orderAmount currencyId="EUR">130.0</orderAmount>
            <buyerId>1012075220</buyerId>
            <transactionDetail>
               <transactionId>7740094019</transactionId>
               <itemId>290006116170</itemId>
               <itemTitle>Fixed Price Single Quantity</itemTitle>
            </transactionDetail>
            <transactionDetail>
               <transactionId>7740093019</transactionId>
               <itemId>290006116175</itemId>
               <itemTitle>Fixed Price Single Quantity</itemTitle>
            </transactionDetail>
         </orderDetail>
         <multiplePayouts>false</multiplePayouts>
         <orderPayoutAmount currencyId="EUR">130.0</orderPayoutAmount>
      </orderPayoutDetailType>
      <orderPayoutDetailType>
         <orderDetail>
            <orderId>
               <id>290006116174-7740092019</id>
            </orderId>
            <orderAmount currencyId="EUR">100.0</orderAmount>
            <buyerId>1012075217</buyerId>
            <transactionDetail>
               <transactionId>7740092019</transactionId>
               <itemId>290006116174</itemId>
               <itemTitle>Fixed Price Single Quantity</itemTitle>
            </transactionDetail>
         </orderDetail>
         <multiplePayouts>false</multiplePayouts>
         <orderPayoutAmount currencyId="EUR">100.0</orderPayoutAmount>
      </orderPayoutDetailType>
   </payoutDetail>
</getOrderPayoutDetailsResponse>

getOrderPayoutDetails Change History

Version	Description
1.1.0 2012-04-07	payoutDetail.refund (added): This container is returned in the response if the one or more refunds were issued from the seller to the buyer.
1.0.0 2011-08-03	(added) New call.

User-Contributed Notes

orderId	OrderIdType	Required	Container consisting of the unique identifier for an eBay order.
orderId.id	string	Required	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.

Payout Details API Call Reference Version 1.1.0