Issue Case Refund
POST /post-order/v2/casemanagement/{caseId}/issue_refund
Sellers use this call to issue a full refund to the buyer to resolve an INR or Return case that was filed against the seller. The seller can voluntarily use this call before eBay customer support makes a decision on the case, or after, when and if eBay customer supports rules in favor of the buyer and forces the seller to issue a refund to the buyer.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/casemanagement/{caseId}/issue_refund
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
caseId | string | Required |
The unique identifier of a case. This URI parameter is required in order to identify the case for which a full refund will be issued to the buyer. The case is identified by the caseId that is passed in as part of the call URI.
|
HTTP request headers
All requests made to eBay REST operations require you to provide the authorization
HTTP header for authentication.
See HTTP request headers for details.
Authorization
This call uses standard authorization tokens. See Making a Call for details.
Payload model
The following lists all fields that could be included in the request.
{ /* CaseVoluntaryRefundRequest */ "comments": { /* Text */ "content": string, "language": string, "translatedFromContent": string, "translatedFromLanguage": string } }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
comments | Text | Optional | This is an optional container that allows the seller to add a note or explanation about the refund being issued. |
comments.content | string | Conditional | This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type. |
comments.language | string | Conditional |
This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.
Applicable values are from LanguageEnum:See language. |
comments.translatedFromContent | string | Conditional | If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable. |
comments .translatedFromLanguage |
string | Conditional |
If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.
Applicable values are from LanguageEnum:See translatedFromLanguage. |
Input Samples Change History |
Output
See also Samples.
Payload model
Note: For information about the error fields and how to work with them, see Error Handling.
The following lists all fields that could be included in the response.
{ /* VoluntaryRefundResponse */ "refundResult": { /* VoluntaryRefundResult */ "refundSource": token, "refundStatus": token } }
Response field descriptions
Output Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
refundResult | VoluntaryRefundResult | Always | Contains information about the status and the source of the refund. |
refundResult.refundSource | token | Always |
This enumeration value indicates the payment source used to refund the buyer to resolve an inquiry or case. Applicable values: See RefundPaymentTypeEnum |
refundResult.refundStatus | token | Always |
Indicates the success or failure of a full refund being issued by the seller through an issue_refund call. PENDING will be returned if the refundSource value is ECHECK , or if the seller and buyer are handling the refund through a source other than PayPal.Applicable values: See RefundStatusEnum |
Input Output Change History |
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 operation issues a refund to the buyer.
Description
You can use this operation on behalf of the seller to issue a refund for an order line item after the buyer has filed an INR or Return case against the seller.
Input
The caseId path parameter identifies the INR or Return case asociated with the order line item being refunded. This call includes an optional comment from the seller to the buyer.
URL format. See also the non-wrapped version of this URL. POST https://api.ebay.com/post-order/v2/casemanagement/5********7/issue_refund { "comments": { "content": "Your refund is on its way." } }
Output
The reponse payload indicates that an instant refund was successfully issued to the buyer from the seller's PayPal account.
JSON format.
{
"refundResult": {
"refundSource": "INSTANT_REFUND",
"refundStatus": "SUCCESS"
}
}
Input Output Samples |
Change History
Change Date | Description |
---|