Open eBay Subscription Call Reference Version 1.2.0 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

Makes a refund for a subscriber's payment. To use this call, you first must give eBay permission to make refunds on your behalf. You can give this permission with the help of an eBay account manager. Otherwise, the call fails.

The addRefund call applies for a payment for which the getBillingRecords call returned the recordType value as Payment. If a refund is made, the refund will be reflected on the subscriber's billing account.

In addRefund, specify the transactionId value as the value that was returned in the record.recordId field of the getBillingRecords call (for the payment).

To use addRefund, the associated charges must have been credited, e.g. due to automatic crediting by eBay, or due to a credit made with the addCredit call. Thus, for the refund to occur, there must be an existing credit balance.

The addRefund call is generally used only for active accounts, but can be used in other situations as well. Note that by December 2010, eBay will automatically refund all cancelled subscriptions.

Back to top

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<addRefundRequest xmlns="http://www.ebay.com/marketplace/services">
  <externalRefundId> string </externalRefundId>
  <refundAmount> Amount (double) </refundAmount>
  <refundDescription> string </refundDescription>
  <refundTime> dateTime </refundTime>
  <submitterName> string </submitterName>
  <subscriptionId> long </subscriptionId>
  <transactionId> string </transactionId>
</addRefundRequest>

Back to top

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"?>
<addRefundResponse xmlns="http://www.ebay.com/marketplace/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 name="string"> 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 -->
  <refundedAmount> Amount (double) </refundedAmount>
  <refundId> long </refundId>
</addRefundResponse>

Back to top

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.

The call makes a refund to the subscriber with the specified subscription ID.

Description

An application is giving a refund to the subscriber with the specified subscription ID.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<addRefundRequest xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
         <subscriptionId>SubscriptionId</subscriptionId>
         <transactionId>2352194</transactionId>
         <refundAmount currencyId="USD">0.01</refundAmount>
         <refundTime>2010-09-10T00:40:12.187Z</refundTime>
         <submitterName>UserName</submitterName>
         <refundDescription>TestDescription</refundDescription>
         <externalRefundId>1001015</externalRefundId>
</addRefundRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<addRefundResponse xmlns:ms="http://www.ebay.com/marketplace/services" xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
         <ack>Success</ack>
         <version>1.2.0</version>
         <timestamp>2010-10-01T00:09:37.930Z</timestamp>
         <refundId>685</refundId>
         <refundedAmount currencyId="USD">0.01</refundedAmount>
</addRefundResponse>

Back to top

Back to top

© 2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.