POST/payment_dispute/{payment_dispute_id}/add_evidence
This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. 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: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.
The file(s) to add are identified through the files array in the request payload. Adding one or more new evidence files for a payment dispute triggers the creation of an evidence file, and the unique identifier for the new evidence file is automatically generated and returned in the evidenceId field of the addEvidence response payload upon a successful call.
The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type.
Upon a successful call, an evidenceId value is returned in the response. This indicates that a new evidence set has been created for the payment dispute, and this evidence set includes the evidence file(s) that were passed in to the fileId array. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent 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 parameter is used to specify the unique identifier of the contested payment dispute for which the seller wishes to add evidence files. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
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
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| evidenceType | EvidenceTypeEnum | This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field. Occurrence: Required |
| files | array of FileEvidence | This array is used to specify one or more evidence files that will become part of a new evidence set associated with a payment dispute. At least one evidence file must be specified in the files array. Occurrence: Required |
| files.fileId | string | This field is used to identify the evidence file to be uploaded to the evidence set. Occurrence: Required |
| lineItems | array of OrderLineItems | This array identifies the order line item(s) for which the evidence file(s) will be applicable. Occurrence: Required |
| lineItems.itemId | string | The unique identifier of the eBay listing associated with the order. Occurrence: Required |
| lineItems.lineItemId | string | The unique identifier of the line item within the order. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| evidenceId | string | The value returned in this field is the unique identifier of the newly-created evidence set. Upon a successful call, this value is automatically genererated. This new evidence set for the payment dispute includes the evidence file(s) that were passed in to the fileId array in the request payload. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent 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 |
| 33003 | API_FULFILLMENT | REQUEST | Invalid Evidence File Id |
| 33004 | API_FULFILLMENT | REQUEST | Upload file for evidence is not permitted for given payment dispute state. |
| 33007 | API_FULFILLMENT | REQUEST | Invalid line items. |
| 33008 | API_FULFILLMENT | REQUEST | Invalid evidence type. |
| 33009 | API_FULFILLMENT | REQUEST | User did not echo back the evidence metadata correctly. |
| 33100 | API_FULFILLMENT | REQUEST | Invalid input request |
| 33103 | API_FULFILLMENT | REQUEST | Exceed allowed file count |
| 33104 | API_FULFILLMENT | REQUEST | The combined size of attached files should be 1.5MB or less. |
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: Create an evidence set
In this call, the seller is creating a new evidence set with one new evidence file. The unique identifier of the payment dispute is passed in as a path parameter, and the evidence file is identified in the request payload.
Input
After passing in the payment dispute ID as a path parameter, the request payload is used to identify the ID of the evidence file that will initiate the new evidence set, to identify the order line item, and to specify the type of evidence being provided.
POSThttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********2/add_evidence
Output
With a successful call, the response payload shows the unique identifier of the new evidence set that was successfully create. This evidence set ID will be used if the seller wishes to add files to this evidence set using the updateEvidence method.