Issue Inquiry Refund
POST /post-order/v2/inquiry/{inquiryId}/issue_refund
This method can be used on behalf of the seller to issue a full refund to the buyer for the missing line item. This method will be used if the buyer is seeking a full refund for the missing line item and the seller has yet to ship the line item.Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.
Output Samples Change History |
Input
See also Samples.
Resource URI (production)
POST https://api.ebay.com/post-order/v2/inquiry/{inquiryId}/issue_refund
URI parameters
Parameter | Type | Required? | Meaning |
---|---|---|---|
inquiryId | string | Required | The unique ID of the inquiry for which a refund is to be issued. The inquiry ID value 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.
{ /* InquiryVoluntaryRefundRequest */ "comments": { /* Text */ "content": string, "language": string, "translatedFromContent": string, "translatedFromLanguage": string } }
Request field descriptions
Input Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
comments | Text | Optional | This container is used if the seller wants 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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
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. The full list of language enumeration values are defined in the LanguageEnum type definition. Applicable values: See LanguageEnum |
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": string, "refundStatus": string } }
Response field descriptions
Output Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
refundResult | VoluntaryRefundResult | Always | This container shows the result of the refund action and the source being used for the buyer refund. |
refundResult.refundSource | string | Always |
This enumeration value indicates the payment source used to refund the buyer to resolve an inquiry or case.
Applicable values are from RefundPaymentTypeEnum: Code so that your app gracefully handles any future changes to this list. |
refundResult.refundStatus | string | Always |
This enumeration value indicates the success or failure of a full refund being issued by the seller through an issue_refund method.
Applicable values are from RefundStatusEnum: Code so that your app gracefully handles any future changes to this list. |
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 inquiry. A refund should only be issued by the seller if a refund is what the buyer is expecting. In some cases, the buyer still wants the item. The buyer's desired outcome is stated when the buyer creates the inquiry (either 'I want a full refund' or 'I still want the item').
Input
The inquiryId path parameter identifies the INR inquiry 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/inquiry/5********9/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 |
---|