GET/payment_dispute/{payment_dispute_id}/fetch_evidence_content
This call retrieves a specific evidence file for a payment dispute. The following three identifying parameters are needed in the call URI:
- payment_dispute_id: the identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response.
- evidence_id: the identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response.
- file_id: the identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.
An actual binary file is returned if the call is successful. An error will occur if any of three identifiers are invalid.
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 | The identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response. This identifier is passed in as a path parameter at the end of the call URI. Occurrence: Required |
| evidence_id | string | The identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response. Below is an example of the syntax to use for this query parameter: evidence_id=12345678 Occurrence: Required |
| file_id | string | The identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response. Below is an example of the syntax to use for this query parameter: file_id=12345678 Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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
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
This call has no payload.
Response fields
This call has no field definitions.
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 | Invalid Payment Dispute Id |
| 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 |
| 33002 | API_FULFILLMENT | REQUEST | Invalid Evidence Id |
| 33003 | API_FULFILLMENT | REQUEST | Invalid Evidence File Id |
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: Get an evidential file for a payment dispute
Get an evidential file for a payment dispute.
Input
Seller inputs a unique payment dispute identifier into the call URI to identify the payment dispute, and then provides the unique evidence set identifier and unique file identifier through the evidence_id and file_id query parameters
GEThttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********2/fetch_evidence_content?evidence_id=1****6&file_id=1*******9
Output
There is no response payload for this call; instead, a successful call retrieves a binary version of the evidential file.