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 Activity

Production
https://api.ebay.com{basePath}
Production
https://api.ebay.com{basePath}
GET
/payment_dispute/{payment_dispute_id}/activity
This method retrieve a log of activity for a payment dispute. The identifier of the payment dispute is passed in as a path parameter. The output includes a timestamp for each action of the payment dispute, from creation to resolution, and all steps in between.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.ebay.com{basePath}/payment_dispute//activity'
Response Response Example
200 - Example 1
{
    "activity": [
        {
            "activityDate": "string",
            "activityType": "string",
            "actor": "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 for which the user wishes to see all activity. 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.

Responses

🟢200Success
application/json
Body
This type is used by the base response of the getActivities method, and includes a log of all activities of a payment dispute, from creation to resolution.
activity
array[object (PaymentDisputeActivity) {3}] 
optional
This array holds all activities of a payment dispute, from creation to resolution. For each activity, the activity type, the actor, and a timestamp is shown. The getActivities response is dynamic, and grows with each recorded activity.
activityDate
string 
optional
The timestamp in this field shows the date/time of the payment dispute activity. 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.
activityType
string 
optional
This enumeration value indicates the type of activity that occured on the payment dispute. For example, a value of DISPUTE_OPENED is returned when a payment disute is first created, a value indicating the seller's decision on the dispute, such as SELLER_CONTEST, is returned when seller makes a decision to accept or contest dispute, and a value of DISPUTE_CLOSED is returned when a payment disute is resolved. See ActivityEnum for an explanation of each of the values that may be returned here. For implementation help, refer to eBay API documentation
actor
string 
optional
This enumeration value indicates the actor that performed the action. Possible values include the BUYER, SELLER, CS_AGENT (eBay customer service), or SYSTEM. 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
Accept Payment Dispute
Next
Add an Evidence File
Built with