Note: Before contesting a payment dispute, the seller must upload all evidence 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 evidence 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 evidential documents such as proof of delivery, proof of authentication, or other documents. The type of evidential documents that the seller will provide will depend on why the buyer initiated 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 theste fields.
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 contest. 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.
|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. |
|returnAddress.addressLine1||string||The first line of the street address. |
|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. |
|returnAddress.city||string||The city of the return address. |
|returnAddress.country||CountryCodeEnum||The country's two-digt, ISO 3166-1 country code. See the enumeration type for a country's value. |
|returnAddress.county||string||The county of the return address. Counties are not applicable to all countries. |
|returnAddress.fullName||string||The full name of return address owner. |
|returnAddress.postalCode||string||The postal code of the return address. |
|returnAddress.primaryPhone||Phone||This container shows the seller's primary phone number associated with the return address. |
|returnAddress.primaryPhone.countryCode||string||The seller's country calling code. 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. For a full list of calling codes for all countries, see the countrycode.org site. |
|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: |
If the buyer is located in a different country than the seller, the seller's country calling code will need to be specified in the countryCode field.
|returnAddress.stateOrProvince||string||The state or province of the return address. |
|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. |
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.|
|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|
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
204 Successis returned. This method has no response payload.