Contest Payment Dispute

Production

https://api.ebay.com{basePath}

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.ebay.com{basePath}/payment_dispute//contest' \
--header 'Content-Type: application/json' \
--data-raw '{
    "returnAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "fullName": "string",
        "postalCode": "string",
        "primaryPhone": {
            "countryCode": "string",
            "number": "string"
        },
        "stateOrProvince": "string"
    },
    "revision": 0
}'

Response Example

204 - Example 1

{}

Request

Path Params

payment_dispute_id

string

required

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.

Body Params application/json

This type is used by the request payload of the contestPaymentDispute method.

returnAddress

object (ReturnAddress)

optional

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.

addressLine1

string

optional

The first line of the street address.

addressLine2

string

optional

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.

city

string

optional

The city of the return address.

country

string

optional

The country's two-digt, ISO 3166-1 country code. See the enumeration type for a country's value. For implementation help, refer to eBay API documentation

county

string

optional

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

fullName

string

optional

The full name of return address owner.

postalCode

string

optional

The postal code of the return address.

primaryPhone

object (Phone)

optional

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

stateOrProvince

string

optional

The state or province of the return address.

revision

integer <int32>

optional

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.

Examples

Responses

🟢204Success

application/json

Body

object {0}

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Modified at 2022-09-11 20:21:04

Add an Evidence File

Get Payment Dispute Evidence File