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 unique identifier of the evidence set to update is specified through the evidenceId field, and the file(s) to add are identified through the files array in the request payload. The unique identifier for an evidence file is automatically generated and returned in the fileId field of the uploadEvidence response payload upon a successful call. Sellers must make sure to capture the fileId value for each evidence file that is uploaded with the uploadEvidence method.
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 http status code of
204 Successis returned. There is no response payload unless an error occurs. To verify that a new file is a part of the evidence set, the seller can use the fetchEvidenceContent method, passing in the proper evidenceId and fileId values.
Resource URI (production)
|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 update the evidence set for a contested payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay managed payments 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.
HTTP request headers
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):
See OAuth access tokens for more information.
|evidenceId||string||The unique identifier of the evidence set that is being updated with new evidence files. |
|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. See the EvidenceTypeEnum type for the supported evidence types. |
|files||array of FileEvidence||This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.|
The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method.
|files.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.|
Note that if an evidence set already exists for a payment dispute, the getPaymentDispute method will return both the evidenceId (unique identifier of evidence set) value, and the fileId (unique identifier of a file within that evidence set) value(s).
|lineItems||array of OrderLineItems||This required array identifies the order line item(s) for which the evidence file(s) will be applicable. Both the itemId and lineItemID fields are needed to identify each order line item, and both of these values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response. |
|lineItems.itemId||string||The unique identifier of the eBay listing associated with the order. |
|lineItems.lineItemId||string||The unique identifier of the line item within the order. The lineItemId value is created once the buyer actually purchases the item, or if there is a commitment to buy (such as an auction that is won by the buyer, an accepted Best Offer, or other situation that does not require immediate payment from the buyer). |
For more on errors, plus the codes of other common errors, see Handling errors.
|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.|
|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.|
|33010||API_FULFILLMENT||REQUEST||Evidence Id is invalid|
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 existing evidence set
204 Successis returned, and there is no response payload.