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
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the apiz.ebay.com root URI with apiz.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| payment_dispute_id | string | This parameter is used to specify the unique identifier of the payment dispute being retrieved. Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code 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.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| amount | SimpleAmount | This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. Occurrence: Always |
| amount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code (such as Occurrence: Conditional |
| amount.value | string | The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. Occurrence: Conditional |
| availableChoices | array of SellerDecisionEnum | 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. Occurrence: Conditional |
| buyerProvided | InfoFromBuyer | 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. Occurrence: Conditional |
| buyerProvided.contentOnHold | boolean | When the value of this field is Occurrence: Conditional |
| buyerProvided.note | string | This field shows any note that was left by the buyer in regard to the dispute. Occurrence: Conditional |
| buyerProvided.returnShipmentTracking | array of TrackingInfo | This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute. Occurrence: Conditional |
| buyerProvided.returnShipmentTracking.shipmentTrackingNumber | string | This string value represents the shipment tracking number of the package. Occurrence: Conditional |
| buyerProvided.returnShipmentTracking.shippingCarrierCode | string | This string value represents the shipping carrier used to ship the package. Occurrence: Conditional |
| buyerUsername | string | This is the eBay user ID of the buyer that initiated the payment dispute. Occurrence: Always |
| closedDate | string | 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 Occurrence: Conditional |
| evidence | array of DisputeEvidence | 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. Occurrence: Conditional |
| evidence.evidenceId | string | 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. Occurrence: Conditional |
| evidence.evidenceType | EvidenceTypeEnum | This enumeration value shows the type of evidential file provided. Occurrence: Conditional |
| evidence.files | array of FileInfo | This array shows the name, ID, file type, and upload date for each provided file. Occurrence: Conditional |
| evidence.files.fileId | string | The unique identifier of the evidence file. Occurrence: Conditional |
| evidence.files.fileType | string | The type of file uploaded. Supported file extensions are .JPEG, .JPG, and .PNG., and maximum file size allowed is 1.5 MB. Occurrence: Conditional |
| evidence.files.name | string | The seller-provided name of the evidence file. Occurrence: Conditional |
| evidence.files.uploadedDate | string | The timestamp in this field shows the date/time when the seller uploaded the evidential document to eBay. Occurrence: Conditional |
| evidence.lineItems | array of OrderLineItems | This array shows one or more order line items associated with the evidential document that has been provided. Occurrence: Conditional |
| evidence.lineItems.itemId | string | The unique identifier of the eBay listing associated with the order. Occurrence: Always |
| evidence.lineItems.lineItemId | string | The unique identifier of the line item within the order. Occurrence: Always |
| evidence.providedDate | string | The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay. Occurrence: Conditional |
| evidence.requestDate | string | The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. Occurrence: Conditional |
| evidence.respondByDate | string | The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay. Occurrence: Conditional |
| evidence.shipmentTracking | array of TrackingInfo | This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the evidence container if the seller has provided shipment tracking information as evidence to support Occurrence: Conditional |
| evidence.shipmentTracking.shipmentTrackingNumber | string | This string value represents the shipment tracking number of the package. Occurrence: Conditional |
| evidence.shipmentTracking.shippingCarrierCode | string | This string value represents the shipping carrier used to ship the package. Occurrence: Conditional |
| evidenceRequests | array of EvidenceRequest | This container is returned if one or more evidence documents are being requested from the seller. Occurrence: Conditional |
| evidenceRequests.evidenceId | string | 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. Occurrence: Conditional |
| evidenceRequests.evidenceType | EvidenceTypeEnum | This enumeration value shows the type of evidential document provided. Occurrence: Conditional |
| evidenceRequests.lineItems | array of OrderLineItems | This array shows one or more order line items associated with the evidential document that has been provided. Occurrence: Conditional |
| evidenceRequests.lineItems.itemId | string | The unique identifier of the eBay listing associated with the order. Occurrence: Always |
| evidenceRequests.lineItems.lineItemId | string | The unique identifier of the line item within the order. Occurrence: Always |
| evidenceRequests.requestDate | string | The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. Occurrence: Conditional |
| evidenceRequests.respondByDate | string | The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay. Occurrence: Conditional |
| lineItems | array of OrderLineItems | 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. Occurrence: Always |
| lineItems.itemId | string | The unique identifier of the eBay listing associated with the order. Occurrence: Always |
| lineItems.lineItemId | string | The unique identifier of the line item within the order. Occurrence: Always |
| monetaryTransactions | array of MonetaryTransaction | 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. Occurrence: Conditional |
| monetaryTransactions.date | string | This timestamp indicates when the monetary transaction occurred. A date is returned for all monetary transactions. Occurrence: Conditional |
| monetaryTransactions.type | MonetaryTransactionTypeEnum | This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller. Occurrence: Conditional |
| monetaryTransactions.reason | MonetaryTransactionReasonEnum | This enumeration value indicates the reason for the monetary transaction. Occurrence: Conditional |
| monetaryTransactions.amount | DisputeAmount | The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well. Occurrence: Conditional |
| monetaryTransactions.amount.convertedFromCurrency | CurrencyCodeEnum | The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency. Occurrence: Conditional |
| monetaryTransactions.amount.convertedFromValue | string | The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field. Occurrence: Conditional |
| monetaryTransactions.amount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| monetaryTransactions.amount.exchangeRate | string | The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field. Occurrence: Conditional |
| monetaryTransactions.amount.value | string | The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type. Occurrence: Conditional |
| note | string | This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth. Occurrence: Conditional |
| openDate | string | 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. Occurrence: Always |
| orderId | string | This is the unique identifier of the order involved in the payment dispute. Occurrence: Always |
| paymentDisputeId | string | 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 system. Occurrence: Always |
| paymentDisputeStatus | DisputeStateEnum | 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. Occurrence: Always |
| reason | DisputeReasonEnum | 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. Occurrence: Always |
| resolution | PaymentDisputeOutcomeDetail | This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes. Occurrence: Conditional |
| resolution.fees | SimpleAmount | 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. Occurrence: Conditional |
| resolution.fees.currency | CurrencyCodeEnum | A three-letter ISO 4217 code (such as Occurrence: Conditional |
| resolution.fees.value | string | The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. Occurrence: Conditional |
| resolution.protectedAmount | SimpleAmount | This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy. Occurrence: Conditional |
| resolution.protectedAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code (such as Occurrence: Conditional |
| resolution.protectedAmount.value | string | The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. Occurrence: Conditional |
| resolution.protectionStatus | ProtectionStatusEnum | 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. Occurrence: Conditional |
| resolution.reasonForClosure | OutcomeEnum | 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. Occurrence: Conditional |
| resolution.recoupAmount | SimpleAmount | 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. Occurrence: Conditional |
| resolution.recoupAmount.currency | CurrencyCodeEnum | A three-letter ISO 4217 code (such as Occurrence: Conditional |
| resolution.recoupAmount.value | string | The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. Occurrence: Conditional |
| resolution.totalFeeCredit | SimpleAmount | This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled. Occurrence: Conditional |
| resolution.totalFeeCredit.currency | CurrencyCodeEnum | A three-letter ISO 4217 code (such as Occurrence: Conditional |
| resolution.totalFeeCredit.value | string | The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container. Occurrence: Conditional |
| respondByDate | string | 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 Occurrence: Conditional |
| returnAddress | ReturnAddress | 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. Occurrence: Conditional |
| returnAddress.addressLine1 | string | The first line of the street address. Occurrence: Conditional |
| returnAddress.addressLine2 | string | 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. Occurrence: Conditional |
| returnAddress.city | string | The city of the return address. Occurrence: Conditional |
| returnAddress.country | CountryCodeEnum | The country's two-letter, ISO 3166-1 country code. See the enumeration type for a country's value. Occurrence: Conditional |
| returnAddress.county | string | The county of the return address. Counties are not applicable to all countries. Occurrence: Conditional |
| returnAddress.fullName | string | The full name of return address owner. Occurrence: Conditional |
| returnAddress.postalCode | string | The postal code of the return address. Occurrence: Conditional |
| returnAddress.primaryPhone | Phone | This container shows the seller's primary phone number associated with the return address. Occurrence: Conditional |
| returnAddress.primaryPhone.countryCode | string | The two-letter, ISO 3166 code associated with the seller's phone number. 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 Occurrence: Conditional |
| returnAddress.primaryPhone.number | string | The 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: Occurrence: Conditional |
| returnAddress.stateOrProvince | string | The state or province of the return address. Occurrence: Conditional |
| revision | integer | 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. Occurrence: Always |
| sellerResponse | SellerResponseEnum | 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. Occurrence: Conditional |
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
This call has no 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 4: Get resolved payment dispute
Get a resolved INR-related payment dispute that was accepted by the seller.
Input
Seller inputs a unique payment dispute identifier into the call URI.
GEThttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/5********0
Output
As indicated by the paymentDisputeStatus field, the 'Item not received' payment dispute between buyer and seller is closed. As indicated in the resolution.reasonForClosure field, the seller accepted the dispute. The buyer is automatically refunded by eBay, and eBay recoups that money by charging the seller for the buyer refund amount. The seller is eligible to receive a credit for the final value fees. The amount of money that eBay is recouping is shown in the resolution.recoupAmount container and the amount of fee credits due back to the seller is shown in the resolution.totalFeeCredit container.
The monetaryTransactions container in the response summarizes the single monetary transaction that occurred with this payment dispute, and this is the charge from eBay to the seller to recoup the refund amount issued to the buyer. This order was an active cross-border trade order where a Canadian seller created a listing on the eBay US marketplace. Due to this scenario, the monetaryTransactions.amount container shows the amount of the order in US currency (paid by the buyer), and what that value converts to in Canadian dollars. The exchange rate used for the conversion is also shown.