POST/payment_dispute/{payment_dispute_id}/upload_evidence_file
This method is used to upload an evidence file for a contested payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.
Note: The uploadEvidenceFile only uploads an encrypted, binary image file (using multipart/form-data HTTP request header), and does not have a JSON-based request payload.
Use 'file' as the name of the key that you use to upload the image file. The upload will not be successful if a different key name is used.
The three image formats supported at this time are .JPEG, .JPG, and .PNG.
After the file is successfully uploaded, the seller will need to grab the fileId value in the response payload to add this file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the apiz.ebay.com root URI with apiz.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| payment_dispute_id | string | This is the unique identifier of the payment dispute. This path parameter must be passed into the call URI to identify the payment dispute for which the user plans to upload an evidence file. This identifier is automatically created by eBay after the payment dispute comes into the eBay system. The unique identifier for payment disputes is returned in the paymentDisputeId field in the getPaymentDisputeSummaries response. This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
In addition, this method requires you to include the Content-Type header and its value should be set to "multipart/form-data". See HTTP request headers- opens rest request components page for details.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.payment.dispute
See OAuth access tokens for more information.
Request payload
Note: The uploadEvidenceFile only uploads an encrypted, binary image file (using multipart/form-data HTTP request header), and does not have a JSON-based request payload.
Use 'file' as the name of the key that you use to upload the image file. The upload will not be successful if a different key name is used.
The three image formats supported at this time are .JPEG, .JPG, and .PNG.
Once the file is successfully uploaded, the seller will need to grab the fileId value in the response payload to add this file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method.
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| fileId | string | If an uploadEvidenceFile call is successful, a unique identifier of this evidence file will be returned in the uploadEvidenceFile response payload. This unique fileId value is then used to either add this evidence file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not Found |
| 409 | Conflict |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 33000 | API_FULFILLMENT | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 33001 | API_FULFILLMENT | REQUEST | Invalid Payment Dispute Id |
| 33004 | API_FULFILLMENT | REQUEST | Upload file for evidence is not permitted for given payment dispute state. |
| 33005 | API_FULFILLMENT | REQUEST | File type is invalid. |
| 33006 | API_FULFILLMENT | REQUEST | File size should be 1.5 MB or less. |
| 33105 | API_FULFILLMENT | REQUEST | You reached the maximum number of files you can upload. |
| 33106 | API_FULFILLMENT | REQUEST | The file name should not be empty and should not exceed 255 characters. |
| 33107 | API_FULFILLMENT | REQUEST | Only one file can be uploaded per request. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Upload an evidence file
The seller uploads an evidence file (in .JPG format) using multipart/form-data HTTP request header. The unique identifier of the payment dispute (to associate the file with) is passed in as a path parameter.
Input
There is no request payload. A .JPG file is uploaded using multipart/form-data HTTP request header.
POSThttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********2/upload_evidence_file
Output
With a successful call, the response payload shows the unique identifier of the evidence file that was successfully uploaded. This file ID will be used when adding this file to a new or existing evidence set.