POST/payment_dispute/{payment_dispute_id}/contest
This method is used if the seller wishes to contest 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: Before contesting a payment dispute, the seller must upload all supporting files using the addEvidence and updateEvidence methods. Once the seller has officially contested the dispute (using contestPaymentDispute), 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 supporting file(s) that will be needed to contest the payment dispute.
If a seller decides to contest a payment dispute, that seller should be prepared to provide supporting documents such as proof of delivery, proof of authentication, or other documents. The type of supporting documents that the seller will provide will depend on why the buyer filed the payment dispute.
The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on these fields.
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 payment dispute being contested. 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 |
|---|---|---|
| note | string | This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth. Occurrence: Optional |
| returnAddress | ReturnAddress | This container is needed if the seller is requesting that the buyer return the item. If this container is used, all relevant fields must be included, including fullName and primaryPhone. Occurrence: Conditional |
| returnAddress.addressLine1 | string | The first line of the street address. Occurrence: Conditional |
| returnAddress.addressLine2 | string | The second line of the street address. This line is not always necessarily, but is often used for apartment number or suite number, or other relevant information that can not fit on the first line. Occurrence: Conditional |
| returnAddress.city | string | The city of the return address. Occurrence: Conditional |
| returnAddress.country | CountryCodeEnum | The country's two-letter, ISO 3166-1 country code. See the enumeration type for a country's value. Occurrence: Conditional |
| returnAddress.county | string | The county of the return address. Counties are not applicable to all countries. Occurrence: Conditional |
| returnAddress.fullName | string | The full name of return address owner. Occurrence: Conditional |
| returnAddress.postalCode | string | The postal code of the return address. Occurrence: Conditional |
| returnAddress.primaryPhone | Phone | This container shows the seller's primary phone number associated with the return address. Occurrence: Conditional |
| returnAddress.primaryPhone.countryCode | string | The two-letter, ISO 3166 code associated with the seller's phone number. This field is needed if the buyer is located in a different country than the seller. It is also OK to provide if the buyer and seller are both located in the same country Occurrence: Conditional |
| returnAddress.primaryPhone.number | string | The seller's primary phone number associated with the return address. When this number is provided in a contestPaymentDispute or contestPaymentDispute method, it is provided as one continuous numeric string, including the area code. So, if the phone number's area code was '408', a number in this field may look something like this: Occurrence: Conditional |
| returnAddress.stateOrProvince | string | The state or province of the return address. Occurrence: Conditional |
| revision | integer | This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1. Occurrence: Required |
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 |
|---|---|
| 204 | 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. |
| 33011 | API_FULFILLMENT | REQUEST | There was a change in payment dispute attributes. Please use get payment dispute api to get latest details. |
| 33100 | API_FULFILLMENT | REQUEST | Invalid input request |
| 33101 | API_FULFILLMENT | REQUEST | Invalid payment dispute state |
| 33102 | API_FULFILLMENT | REQUEST | No evidence available for contest |
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: Contest a payment dispute
The seller contests a payment dispute. The unique identifier of the payment dispute is passed in as a path parameter.
Input
After passing in the unique identifier of the payment dispute as a path parameter, the seller sets the revision value and provides the return address where the buyer will return the item.
POSThttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********2/contest
Output
With a successful call, an http status code of 204 Success is returned. This method has no response payload.