getRefundStatus - Call Reference - Open eBay Subscription API

getRefundStatus

Retrieves records of refunds. You can request refunds for a subscription ID, or you can specify a transaction ID (in this case, a refundId value returned in an addRefund response). If you do not specify a transaction ID (a refundId returned by addRefund) or a subscription ID, the set of refunds that applies to your subscribers is returned. You also can specify a time range.

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

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<getRefundStatusResponse 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 -->
  <refundStatusInfo> RefundStatusInfo
    <errorCode> string </errorCode>
    <refundedAmount currencyId="string"> Amount (double) </refundedAmount>
    <refundRequestedDate> dateTime </refundRequestedDate>
    <refundStatus> string </refundStatus>
    <submitterType> string </submitterType>
    <subscriptionId> long </subscriptionId>
    <transactionId> string </transactionId>
  </refundStatusInfo>
  <!-- ... more refundStatusInfo nodes here ... -->
</getRefundStatusResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	Indicates whether or not errors or warnings were generated during the processing of the request. Applicable values: • Failure (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) The request that triggered the error was processed successfully but with some warnings. • Success (out) The request was processed successfully, but something occurred that may affect your application or the user. • Warning (out) The request that triggered the error was processed successfully but with some warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	ActivityProfile about a single error.
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, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the appilcation or data is resolved, resend the corrected request to eBay. • Request (out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. • System (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is 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 upon which the error occurred. Domains include: Marketplace A business or validation error occurred for the UserProfile Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
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 resulted in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Some 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.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please 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, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is 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. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: • Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain upon which the error occurred. Subdomains include the following: UserProfile (in which the error is specific to the UserProfile service) and MarketplaceCommon (in which the error is common to all Marketplace services).
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.
version	string	Always	The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes.

Call-specific Output Fields

refundStatusInfo	RefundStatusInfo	Conditionally, repeatable: [0..*]	Container for information about a refund.
refundStatusInfo.errorCode	string	Conditionally	An error code that applies to the refund. The error code can be 2509 (refund rejected), 2510 (refund amount is greater than any of the payments), or 2511 (timeout error).
refundStatusInfo .refundedAmount	Amount (double)	Conditionally	Amount of the refund for the transaction.
refundStatusInfo .refundedAmount [ attribute currencyId ]	string	Conditionally	Currency in which the monetary amount is specified. A three-letter ID, such as USD, CAD, DEM. Currently, USD is the only available value.
refundStatusInfo .refundRequestedDate	dateTime	Conditionally	Date of the refund request.
refundStatusInfo.refundStatus	string	Conditionally	This refund status is one of the following: Submitted, Pending, Processed, or Failed.
refundStatusInfo.submitterType	string	Conditionally	This value is either "S" (for "service") or B (for "batch"). "Service" means initiated by a third-party developer, or initiated manually. "Batch" applies in other cases, e.g. if a subscription was cancelled, and as a result, a refund was made.
refundStatusInfo .subscriptionId	long	Conditionally	For a particular application, the subscriptionId uniquely identifies a user's subscription.
refundStatusInfo.transactionId	string	Conditionally	The refund ID that is returned in the addRefund response. Max length: 256.

getRefundStatus 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 Call

The call requests the status of a refund for a specified subscriptionId.

Description

An application is requesting the status of a refund for the specified subscriptionId.

Input

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

<?xml version="1.0" encoding="UTF-8"?>
<getRefundStatusRequest xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
         <subscriptionId>SubscriptionId</subscriptionId>
</getRefundStatusRequest>

Output

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

<?xml version="1.0" encoding="UTF-8"?>
<getRefundStatusResponse xmlns="http://www.ebay.com/marketplace/openebay/v1/services">
         <ack>Success</ack>
         <version>1.1.0</version>
         <timestamp>2010-09-07T16:36:46.437Z</timestamp>
         <refundStatusInfo>
            <refundStatus>Submitted</refundStatus>
            <submitterType>B</submitterType>
            <subscriptionId>SubscriptionId</subscriptionId>
            <transactionId>185</transactionId>
            <refundedAmount currencyId="USD">0.01</refundedAmount>
            <refundRequestedDate>2010-09-03T01:15:13.000Z</refundRequestedDate>
         </refundStatusInfo>
         <refundStatusInfo>
            <refundStatus>Submitted</refundStatus>
            <submitterType>B</submitterType>
            <subscriptionId>SubscriptionId</subscriptionId>
            <transactionId>186</transactionId>
            <refundedAmount>-44.44</refundedAmount>
            <refundRequestedDate>2010-09-06T04:58:34.000Z</refundRequestedDate>
         </refundStatusInfo>
         <refundStatusInfo>
            <refundStatus>Submitted</refundStatus>
            <submitterType>B</submitterType>
            <subscriptionId>SubscriptionId</subscriptionId>
            <transactionId>187</transactionId>
            <refundedAmount>-44.44</refundedAmount>
            <refundRequestedDate>2010-09-06T05:04:05.000Z</refundRequestedDate>
         </refundStatusInfo>
         <refundStatusInfo>
            <refundStatus>Submitted</refundStatus>
            <submitterType>B</submitterType>
            <subscriptionId>SubscriptionId</subscriptionId>
            <transactionId>188</transactionId>
            <refundedAmount currencyId="USD">-44.44</refundedAmount>
            <refundRequestedDate>2010-09-06T05:13:17.000Z</refundRequestedDate>
         </refundStatusInfo>
         <refundStatusInfo>
            <refundStatus>Submitted</refundStatus>
            <submitterType>B</submitterType>
            <subscriptionId>SubscriptionId</subscriptionId>
            <transactionId>189</transactionId>
            <refundedAmount currencyId="USD">-44.44</refundedAmount>
            <refundRequestedDate>2010-09-06T05:30:18.000Z</refundRequestedDate>
         </refundStatusInfo>
</getRefundStatusResponse>

getRefundStatus Change History

Version	Description
1.2.0 2010-09-29	(added) New call.

User-Contributed Notes

recordTimeRange	TimeRange	Optional	The time range for the retrieval of records. If no time range is specified, the last six months of data is returned.
recordTimeRange.timeFrom	dateTime	Optional	Specifies the earliest (oldest) date to be used in a date range.
recordTimeRange.timeTo	dateTime	Optional	Specifies the latest (most recent) date to be used in a date range.
subscriptionId	long	Optional	For a particular application, the subscription ID uniquely identifies a user's subscription.
transactionId	string	Optional	The refundId value that is returned in the addRefund response. Max length: 256.

Open eBay Subscription Call Reference Version 1.2.0

Open eBay Subscription
Call Reference Version 1.2.0