Fulfillment API
  1. payment_dispute
Fulfillment API
  • order
    • /order
      GET
    • /order/{orderId}
      GET
    • Issue Refund
      POST
  • shipping_fulfillment
    • /order/{orderId}/shipping_fulfillment
      GET
    • /order/{orderId}/shipping_fulfillment
      POST
    • /order/{orderId}/shipping_fulfillment/{fulfillmentId}
      GET
  • payment_dispute
    • Get Payment Dispute Details
      GET
    • Accept Payment Dispute
      POST
    • Get Payment Dispute Activity
      GET
    • Add an Evidence File
      POST
    • Contest Payment Dispute
      POST
    • Get Payment Dispute Evidence File
      GET
    • Update evidence
      POST
    • Upload an Evidence File
      POST
    • Search Payment Dispute by Filters
      GET
  1. payment_dispute

Get Payment Dispute Details

Production
https://api.ebay.com{basePath}
Production
https://api.ebay.com{basePath}
GET
/payment_dispute/{payment_dispute_id}
This method retrieves detailed information on a specific payment dispute. The payment dispute identifier is passed in as path parameter at the end of the call URI. Below is a summary of the information that is retrieved: Current status of payment dispute Amount of the payment dispute Reason the payment dispute was opened Order and line items associated with the payment dispute Seller response options if an action is currently required on the payment dispute Details on the results of the payment dispute if it has been closed Details on any evidence that was provided by the seller to fight the payment dispute
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.ebay.com{basePath}/payment_dispute/'
Response Response Example
200 - Example 1
{
    "amount": {
        "currency": "string",
        "value": "string"
    },
    "availableChoices": [
        "string"
    ],
    "buyerProvided": {
        "note": "string",
        "returnShipmentTracking": [
            {
                "shipmentTrackingNumber": "string",
                "shippingCarrierCode": "string"
            }
        ]
    },
    "buyerUsername": "string",
    "closedDate": "string",
    "evidence": [
        {
            "evidenceId": "string",
            "evidenceType": "string",
            "files": [
                {
                    "fileId": "string",
                    "fileType": "string",
                    "name": "string",
                    "uploadedDate": "string"
                }
            ],
            "lineItems": [
                {
                    "itemId": "string",
                    "lineItemId": "string"
                }
            ],
            "providedDate": "string",
            "requestDate": "string",
            "respondByDate": "string",
            "shipmentTracking": [
                {
                    "shipmentTrackingNumber": "string",
                    "shippingCarrierCode": "string"
                }
            ]
        }
    ],
    "evidenceRequests": [
        {
            "evidenceId": "string",
            "evidenceType": "string",
            "lineItems": [
                {
                    "itemId": "string",
                    "lineItemId": "string"
                }
            ],
            "requestDate": "string",
            "respondByDate": "string"
        }
    ],
    "lineItems": [
        {
            "itemId": "string",
            "lineItemId": "string"
        }
    ],
    "monetaryTransactions": [
        {
            "amount": {
                "convertedFromCurrency": "string",
                "convertedFromValue": "string",
                "currency": "string",
                "exchangeRate": "string",
                "value": "string"
            },
            "date": "string",
            "reason": "string",
            "type": "string"
        }
    ],
    "openDate": "string",
    "orderId": "string",
    "paymentDisputeId": "string",
    "paymentDisputeStatus": "string",
    "reason": "string",
    "resolution": {
        "fees": {
            "currency": "string",
            "value": "string"
        },
        "protectedAmount": {
            "currency": "string",
            "value": "string"
        },
        "protectionStatus": "string",
        "reasonForClosure": "string",
        "recoupAmount": {
            "currency": "string",
            "value": "string"
        },
        "totalFeeCredit": {
            "currency": "string",
            "value": "string"
        }
    },
    "respondByDate": "string",
    "returnAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "fullName": "string",
        "postalCode": "string",
        "primaryPhone": {
            "countryCode": "string",
            "number": "string"
        },
        "stateOrProvince": "string"
    },
    "revision": 0,
    "sellerResponse": "string"
}

Request

Path Params
payment_dispute_id
string 
required
This is the unique identifier of the payment dispute. This path parameter must be passed in at the end of the call URI to identify the payment dispute to retrieve. 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.

Responses

🟢200Success
application/json
Body
This type is used by the base response of the getPaymentDispute method. The getPaymentDispute method retrieves detailed information on a specific payment dispute.
amount
object (SimpleAmount) 
optional
This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace.
currency
string 
optional
A three-letter ISO 4217 code (such as USD for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are always returned with the amount container. For implementation help, refer to eBay API documentation
value
string 
optional
The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container.
availableChoices
array[string]
optional
The value(s) returned in this array indicate the choices that the seller has when responding to the payment dispute. Once the seller has responded to the payment dispute, this field will no longer be shown, and instead, the sellerResponse field will show the decision that the seller made.
buyerProvided
object (InfoFromBuyer) 
optional
This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return.
note
string 
optional
This field shows any note that was left by the buyer for in regards to the dispute.
returnShipmentTracking
array[object (TrackingInfo) {2}] 
optional
This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute.
buyerUsername
string 
optional
This is the eBay user ID of the buyer that initiated the payment dispute.
closedDate
string 
optional
The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
evidence
array[object (DisputeEvidence) {8}] 
optional
This container shows any evidence that has been provided by the seller to contest the payment dispute. Evidence may include shipment tracking information, proof of authentication documentation, image(s) to proof that an item is as described, or financial documentation/invoice. This container is only returned if the seller has provided at least one document used as evidence against the payment dispute.
evidenceId
string 
optional
Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set.
evidenceType
string 
optional
This enumeration value shows the type of evidential file provided. For implementation help, refer to eBay API documentation
files
array[object (FileInfo) {4}] 
optional
This array shows the name, ID, file type, and upload date for each provided file.
lineItems
array[object (OrderLineItems) {2}] 
optional
This array shows one or more order line items associated with the evidential document that has been provided.
providedDate
string 
optional
The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
requestDate
string 
optional
The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
respondByDate
string 
optional
The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
shipmentTracking
array[object (TrackingInfo) {2}] 
optional
This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY.
evidenceRequests
array[object (EvidenceRequest) {5}] 
optional
This container is returned if one or more evidence documents are being requested from the seller.
evidenceId
string 
optional
Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set.
evidenceType
string 
optional
This enumeration value shows the type of evidential document provided. For implementation help, refer to eBay API documentation
lineItems
array[object (OrderLineItems) {2}] 
optional
This array shows one or more order line items associated with the evidential document that has been provided.
requestDate
string 
optional
The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
respondByDate
string 
optional
The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
lineItems
array[object (OrderLineItems) {2}] 
optional
This array is used to identify one or more order line items associated with the payment dispute. There will always be at least one itemId/lineItemId pair returned in this array.
itemId
string 
optional
The unique identifier of the eBay listing associated with the order.
lineItemId
string 
optional
The unique identifier of the line item within the order. The lineItemId value is created once the buyer actually purchases the item, or if there is a commitment to buy (such as an auction that is won by the buyer, an accepted Best Offer, or other situation that does not require immediate payment from the buyer).
monetaryTransactions
array[object (MonetaryTransaction) {4}] 
optional
This array provide details about one or more monetary transactions that occur as part of a payment dispute. This array is only returned once one or more monetary transacations occur with a payment dispute.
amount
object (DisputeAmount) 
optional
The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well.
date
string 
optional
This timestamp indicates when the monetary transaction occurred. A date is returned for all monetary transactions. The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z.
reason
string 
optional
This enumeration value indicates the reason for the monetary transaction. For implementation help, refer to eBay API documentation
type
string 
optional
This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller. For implementation help, refer to eBay API documentation
openDate
string 
optional
The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
orderId
string 
optional
This is the unique identifier of the order involved in the payment dispute. Note: eBay rolled out a new Order ID format in June 2019. The legacy APIs still support the old and new order ID format to identify orders, but only the new order ID format is returned in REST-based API responses.
paymentDisputeId
string 
optional
This is the unique identifier of the payment dispute. This is the same identifier that is passed in to the call URI. This identifier is automatically created by eBay once the payment dispute comes into the eBay Managed Payments system.
paymentDisputeStatus
string 
optional
The enumeration value in this field gives the current status of the payment dispute. The status of a payment dispute partially determines other fields that are returned in the response. For implementation help, refer to eBay API documentation
reason
string 
optional
The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation
resolution
object (PaymentDisputeOutcomeDetail) 
optional
This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes.
fees
object (SimpleAmount) 
optional
This container will show the dollar value of any fees associated with the payment dispute. This container is only returned if there are fees associated with the payment dispute.
protectedAmount
object (SimpleAmount) 
optional
This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy.
protectionStatus
string 
optional
This enumeration value indicates if the seller is fully protected, partially protected, or not protected by eBay for the payment dispute. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation
reasonForClosure
string 
optional
The enumeration value returned in this field indicates the outcome of the payment dispute for the seller. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation
recoupAmount
object (SimpleAmount) 
optional
This container shows the dollar amount being recouped from the seller. This container is empty if the seller wins the payment dispute or if the seller is fully protected by eBay's seller protection policy.
totalFeeCredit
object (SimpleAmount) 
optional
This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled.
respondByDate
string 
optional
The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that currently require action by the seller, that same seller should look at the availableChoices array to see the available actions. The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.
returnAddress
object (ReturnAddress) 
optional
This container gives the address where the order will be returned to. This container is returned if the seller is accepting the payment dispute and will issue a refund to the buyer once the item is returned to this address.
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. Each time an action is taken against a payment dispute, this integer value increases by 1.
sellerResponse
string 
optional
The enumeration value returned in this field indicates how the seller has responded to the payment dispute. The seller has the option of accepting the payment dispute and agreeing to issue a refund, accepting the payment dispute and agreeing to issue a refund as long as the buyer returns the item, or contesting the payment dispute. This field is returned as soon as the seller makes an initial decision on the payment dispute. For implementation help, refer to eBay API documentation
🟠400Bad Request
🟠404Invalid Payment Dispute Id
🔴500Internal Server Error
Modified at 2022-09-11 20:21:04
Previous
/order/{orderId}/shipping_fulfillment/{fulfillmentId}
Next
Accept Payment Dispute
Built with