offerPartialRefund

This call allows a seller to offer a partial refund to a buyer to help resolve an eBay Buyer Protection Significantly Not As Described case. If the partial refund amount is approved by the buyer, the seller may then use the issuePartialRefund call to actually issue the partial refund to the buyer. The issuePartialRefund call can only be successfully used if the payment method is PayPal.

Request Details

In the offerPartialRefund request, the seller must provide the case ID and the case type (always EBP_SNAD for this call) for the case upon which a partial refund will be offered. If the case ID and case type don't match, the request is processed (if case ID is valid) but a warning message is returned.

If not already known, the case ID for an eBay Buyer Protection case can be retrieved with a call to getUserCases. If you make this call, use the EBP_SNAD case type filter to restrict results to Significantly Not As Described eBay Buyer Protection cases. To get more detailed information on an eBay Buyer Protection case, you will want to call getEBPCaseDetail, using the same case ID in the request.

The amount of the proposed refund and the currency to be used are required. The amount value must be less than the case amount. The currency type is passed in as a currencyCode attribute of amount. The currencyCode value should match the currency type used in the transaction.

There is an optional comments field that allows the seller to provide any relevant comments to the buyer.

Working with the Response

The response for offerPartialRefund includes the standard fields for a successful call, which are timestamp and version. If they occur, errors and/or warnings will be returned in an errorMessage container.

Input

See also Samples.

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 the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

<?xml version="1.0" encoding="utf-8"?>
<offerPartialRefundRequest xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- Call-specific Input Fields -->
  <amount> Money (decimal) </amount>
  <caseId> CaseIdType
    <id> string </id>
    <type> CaseType </type>
  </caseId>
  <comments> string </comments>
</offerPartialRefundRequest>

Output

See also Samples.

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 the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<offerPartialRefundResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
  <!-- (No call-specific Output fields) -->

  <!-- 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 values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</offerPartialRefundResponse>

Samples

New to making API calls? Please see Making a 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.

This call is used by a seller to offer a partial refund to the buyer as a way to resolve a Significantly Not As Described case.

Description

This offerPartialRefund call sample offers a partial refund to the buyer as a way to resolve an open eBay Buyer Protection Significantly Not As Described case. The case ID, case type, and the amount of the proposed partial refund are required input fields. The comments field is optional.

This call will fail if an invalid case ID is passed in. If the case ID does not match the case type that is passed in, a warning message will be returned in the request, but the call will succeed (if case ID is valid). The caller must be authenticated to make this call.

This call only returns the standard output fields to indicate a successful call.

Input

A US seller offers a partial refund amount of $5.00 to the buyer. The buyer must accept the partial refund amount before the seller can issue the partial refund.

The case ID is 5********1. 'EBP_SNAD' is passed in as the caseId.type value. '5.0' is passed into the amount field, along with the currencyCode attribute value of 'USD'. The string, "Will you accept a $5.00 partial refund?" is passed into the comments field, and this will appear as a comment to the buyer in the Resolution Center.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header>
      <RequesterCredentials>
        <eBayAuthToken>A********3</eBayAuthToken>
      </RequesterCredentials>
   </soap:Header>
   <soap:Body>
      <offerPartialRefundRequest>
         <caseId>
            <id>5********1</id>
            <type>EBP_SNAD</type>
         </caseId>
         <amount currencyCode="USD">5.0</amount>
         <!--Optional:-->
         <comments>Will you accept a $5.00 partial refund?</comments>
      </offerPartialRefundRequest>
   </soap:Body>
</soap:Envelope>

Output

The seller's partial refund offer of $5.00 US Dollars is successful as indicated by the Success value in the ack field.

SOAP format. Also available is the XML equivalent.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <soap:Header/>
   <soap:Body>
      <offerPartialRefundResponse>
         <ack>Success</ack>
         <version>1.3.0</version>
         <timestamp>2011-03-17T19:14:46.173Z</timestamp>
      </offerPartialRefundResponse>
   </soap:Body>
</soap:Envelope>

   Here is the same output in XML format. Note that this does not include standard values.

XML format. Also available is the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<offerPartialRefundResponse xmlns="http://www.ebay.com/marketplace/resolution/v1/services">
   <ack>Success</ack>
   <version>1.3.0</version>
   <timestamp>2011-03-17T19:14:46.173Z</timestamp>
</offerPartialRefundResponse>

Change History