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.
Input
Resource URI (production)
GET https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/{payment_dispute_id}/activity
URI parameters
| Parameter | Type | Description |
|---|---|---|
| payment_dispute_id | string | 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. 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.
Output
{ /* PaymentDisputeActivityHistory */
"activity" : [
}{ /* PaymentDisputeActivity */
]"activityType" : "ActivityEnum : [DISPUTE_OPENED,ADDITIONAL_EVIDENCE_REQUEST,EVIDENCE_PROVIDED...]",
}| Output container/field | Type | Description |
|---|---|---|
| activity | array of PaymentDisputeActivity | 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. Occurrence: Always |
| activity.activityDate | string | 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. Occurrence: Always |
| activity.activityType | ActivityEnum | 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. Occurrence: Always |
| activity.actor | ActorEnum | This enumeration value indicates the actor that performed the action. Possible values include the BUYER, SELLER, CS_AGENT (eBay customer service), or SYSTEM. Occurrence: Always |
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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 404 | Invalid Payment Dispute Id |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 33000 | API_FULFILLMENT | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 33001 | API_FULFILLMENT | REQUEST | Invalid Payment Dispute Id |
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: Get all activity of a payment dispute
Get all activity of a specific payment dispute.
Input
Seller inputs a unique payment dispute identifier into the call URI to retrieve all activity of this payment dispute.
GET
https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********2/activity
Output
The activity for the specified payment dispute was successfully retrieved. For this payment dispute, four actions occurred: the dispute was opened, the dispute was updated, the seller accepted the dispute, and then the dispute was closed.