fulfillment API1.18.0

contestPaymentDispute

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 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.

Input

Resource URI (production)

POST https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/{payment_dispute_id}/contest

URI parameters

ParameterTypeDescription
payment_dispute_idstringThis 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.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Input container/fieldTypeDescription
returnAddressReturnAddressThis 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.addressLine1stringThe first line of the street address.

Occurrence: Conditional

returnAddress.addressLine2stringThe 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.citystringThe city of the return address.

Occurrence: Conditional

returnAddress.countryCountryCodeEnumThe country's two-digt, ISO 3166-1 country code. See the enumeration type for a country's value.

Occurrence: Conditional

returnAddress.countystringThe county of the return address. Counties are not applicable to all countries.

Occurrence: Conditional

returnAddress.fullNamestringThe full name of return address owner.

Occurrence: Conditional

returnAddress.postalCodestringThe postal code of the return address.

Occurrence: Conditional

returnAddress.primaryPhonePhoneThis container shows the seller's primary phone number associated with the return address.

Occurrence: Conditional

returnAddress.primaryPhone.countryCodestringThe 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.

Occurrence: Conditional

returnAddress.primaryPhone.numberstringThe 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:

"number" : "4088084356"

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.

Occurrence: Conditional

returnAddress.stateOrProvincestringThe state or province of the return address.

Occurrence: Conditional

revisionintegerThis 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

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.

StatusMeaning
204Success
400Bad Request
404Not Found
409Conflict
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
33000API_FULFILLMENTAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
33011API_FULFILLMENTREQUESTThere was a change in payment dispute attributes. Please use get payment dispute api to get latest details.
33100API_FULFILLMENTREQUESTInvalid input request
33101API_FULFILLMENTREQUESTInvalid payment dispute state
33102API_FULFILLMENTREQUESTNo evidence available for contest

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.
POST
https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5000250742/contest

Output

With a successful call, an http status code of 204 Success is returned, and there is no response payload.