Skip to main content
GET
/
v1
/
customer
/
disputes
/
{id}
Show dispute details
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/customer/disputes/{id} \
  --header 'Authorization: Bearer <token>'
{
  "dispute_id": "<string>",
  "create_time": "<string>",
  "update_time": "<string>",
  "disputed_transactions": [
    {
      "buyer_transaction_id": "<string>",
      "seller_transaction_id": "<string>",
      "reference_id": "<string>",
      "create_time": "<string>",
      "transaction_status": "COMPLETED",
      "gross_amount": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "gross_asset": {
        "asset_symbol": "BTC",
        "quantity": "<string>",
        "quantity_in_subunits": "<string>",
        "decimals": 20
      },
      "invoice_number": "<string>",
      "custom": "<string>",
      "buyer": {
        "name": "<string>"
      },
      "seller": {
        "email": "<string>",
        "merchant_id": "<string>",
        "name": "<string>"
      },
      "items": [
        {
          "item_id": "<string>",
          "item_name": "<string>",
          "item_description": "<string>",
          "item_quantity": "<string>",
          "partner_transaction_id": "<string>",
          "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
          "dispute_amount": {
            "currency_code": "<any>",
            "value": "<any>"
          },
          "notes": "<string>",
          "item_type": "PRODUCT",
          "product_details": "<any>",
          "service_details": "<any>",
          "booking_details": "<any>",
          "digital_download_details": "<any>",
          "cancellation_details": "<any>",
          "agreed_refund_details": "<any>"
        }
      ],
      "payment_processor": "<any>"
    }
  ],
  "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
  "status": "OPEN",
  "dispute_amount": {
    "currency_code": "<any>",
    "value": "<any>"
  },
  "dispute_asset": {
    "asset_symbol": "BTC",
    "quantity": "<string>",
    "quantity_in_subunits": "<string>",
    "decimals": 20
  },
  "fee_policy": {},
  "external_reason_code": "<string>",
  "dispute_outcome": {
    "outcome_code": "RESOLVED_BUYER_FAVOUR",
    "outcome_reason": "AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES",
    "amount_refunded": {
      "currency_code": "<any>",
      "value": "<any>"
    },
    "asset_refunded": {
      "asset_symbol": "BTC",
      "quantity": "<string>",
      "quantity_in_subunits": "<string>",
      "decimals": 20
    }
  },
  "adjudications": [
    {
      "type": "DENY_BUYER",
      "adjudication_time": "<string>",
      "reason": "AMOUNT_DIFFERENCE_EXPECTED_DUE_TO_FEES",
      "dispute_life_cycle_stage": "INQUIRY"
    }
  ],
  "money_movements": [
    {
      "affected_party": "SELLER",
      "amount": {
        "currency_code": "<any>",
        "value": "<any>"
      },
      "asset": {
        "asset_symbol": "BTC",
        "quantity": "<string>",
        "quantity_in_subunits": "<string>",
        "decimals": 20
      },
      "initiated_time": "<string>",
      "type": "DEBIT",
      "reason": "DISPUTE_SETTLEMENT_FEE"
    }
  ],
  "fund_movements": [
    {
      "party": "SELLER",
      "amount": {
        "currency_code": "<any>",
        "value": "<any>"
      },
      "asset": {
        "asset_symbol": "BTC",
        "quantity": "<string>",
        "quantity_in_subunits": "<string>",
        "decimals": 20
      },
      "initiated_time": "<string>",
      "type": "DEBIT",
      "reason": "REVERSED_TRANSACTION_FEE"
    }
  ],
  "dispute_life_cycle_stage": "INQUIRY",
  "dispute_channel": "INTERNAL",
  "messages": [
    {
      "posted_by": "BUYER",
      "time_posted": "<string>",
      "content": "<string>",
      "documents": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ]
    }
  ],
  "extensions": {
    "merchant_contacted": true,
    "merchant_contacted_outcome": "NO_RESPONSE",
    "merchant_contacted_time": "<string>",
    "merchant_contacted_mode": "WEBSITE",
    "buyer_contacted_time": "<string>",
    "buyer_contacted_channel": "<string>",
    "billing_dispute_properties": {
      "duplicate_transaction": {
        "received_duplicate": true,
        "original_transaction": {
          "buyer_transaction_id": "<string>",
          "seller_transaction_id": "<string>",
          "reference_id": "<string>",
          "create_time": "<string>",
          "transaction_status": "COMPLETED",
          "gross_amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "gross_asset": {
            "asset_symbol": "BTC",
            "quantity": "<string>",
            "quantity_in_subunits": "<string>",
            "decimals": 20
          },
          "invoice_number": "<string>",
          "custom": "<string>",
          "buyer": {
            "name": "<string>"
          },
          "seller": {
            "email": "<string>",
            "merchant_id": "<string>",
            "name": "<string>"
          },
          "items": [
            {
              "item_id": "<string>",
              "item_name": "<string>",
              "item_description": "<string>",
              "item_quantity": "<string>",
              "partner_transaction_id": "<string>",
              "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
              "dispute_amount": {
                "currency_code": "<any>",
                "value": "<any>"
              },
              "notes": "<string>",
              "item_type": "PRODUCT",
              "product_details": "<any>",
              "service_details": "<any>",
              "booking_details": "<any>",
              "digital_download_details": "<any>",
              "cancellation_details": "<any>",
              "agreed_refund_details": "<any>"
            }
          ],
          "payment_processor": "<any>"
        }
      },
      "incorrect_transaction_amount": {
        "correct_transaction_amount": {
          "currency_code": "<any>",
          "value": "<any>"
        },
        "correct_transaction_asset": {
          "asset_symbol": "BTC",
          "quantity": "<string>",
          "quantity_in_subunits": "<string>",
          "decimals": 20
        },
        "correct_transaction_time": "<string>"
      },
      "payment_by_other_means": {
        "charge_different_from_original": true,
        "received_duplicate": true,
        "payment_method": "CASH",
        "payment_instrument_suffix": "<string>"
      },
      "credit_not_processed": {
        "issue_type": "PRODUCT",
        "expected_refund": {
          "currency_code": "<any>",
          "value": "<any>"
        },
        "cancellation_details": {
          "cancellation_date": "<string>",
          "cancellation_number": "<string>",
          "cancelled": true,
          "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT"
        },
        "product_details": {
          "description": "<string>",
          "product_received": "YES",
          "product_received_time": "<string>",
          "expected_delivery_date": "<string>",
          "sub_reasons": [
            "DAMAGED"
          ],
          "purchase_url": "<string>",
          "return_details": {
            "return_time": "<string>",
            "mode": "SHIPPED",
            "receipt": true,
            "return_confirmation_number": "<string>",
            "returned": true
          }
        },
        "service_details": {
          "description": "<string>",
          "service_started": "YES",
          "note": "<string>",
          "sub_reasons": [
            "DAMAGED"
          ],
          "purchase_url": "<string>"
        },
        "agreed_refund_details": {
          "merchant_agreed_refund": true,
          "merchant_agreed_refund_time": "<string>"
        }
      },
      "canceled_recurring_billing": {
        "expected_refund": {
          "currency_code": "<any>",
          "value": "<any>"
        },
        "cancellation_details": {
          "cancellation_date": "<string>",
          "cancellation_number": "<string>",
          "cancelled": true,
          "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT"
        }
      }
    },
    "merchandize_dispute_properties": {
      "issue_type": "PRODUCT",
      "product_details": {
        "description": "<string>",
        "product_received": "YES",
        "product_received_time": "<string>",
        "expected_delivery_date": "<string>",
        "sub_reasons": [
          "DAMAGED"
        ],
        "purchase_url": "<string>",
        "return_details": {
          "return_time": "<string>",
          "mode": "SHIPPED",
          "receipt": true,
          "return_confirmation_number": "<string>",
          "returned": true
        }
      },
      "service_details": {
        "description": "<string>",
        "service_started": "YES",
        "note": "<string>",
        "sub_reasons": [
          "DAMAGED"
        ],
        "purchase_url": "<string>"
      },
      "cancellation_details": {
        "cancellation_date": "<string>",
        "cancellation_number": "<string>",
        "cancelled": true,
        "cancellation_mode": "CANCELLED_PAYPAL_BILLING_AGREEMENT"
      },
      "return_shipping_address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "admin_area_4": "<string>",
        "admin_area_3": "<string>",
        "admin_area_2": "<string>",
        "admin_area_1": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "address_details": {
          "street_number": "<string>",
          "street_name": "<string>",
          "street_type": "<string>",
          "delivery_service": "<string>",
          "building_name": "<string>",
          "sub_building": "<string>"
        }
      }
    },
    "reported_source": "EMAIL"
  },
  "evidences": [
    {
      "evidence_type": "PROOF_OF_FULFILLMENT",
      "evidence_info": {
        "tracking_info": [
          {
            "carrier_name": "UPS",
            "carrier_name_other": "<string>",
            "tracking_url": "<string>",
            "tracking_number": "<string>"
          }
        ],
        "refund_ids": [
          "<string>"
        ]
      },
      "documents": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "notes": "<string>",
      "source": "REQUESTED_FROM_BUYER",
      "date": "<string>",
      "item_id": "<string>",
      "item_type": "PRODUCT",
      "action_info": {
        "action": "ACKNOWLEDGE_RETURN_ITEM",
        "response_option": "<string>",
        "mandatory": true
      },
      "dispute_life_cycle_stage": "INQUIRY"
    }
  ],
  "buyer_response_due_date": "<string>",
  "seller_response_due_date": "<string>",
  "offer": {
    "buyer_requested_amount": {
      "currency_code": "<any>",
      "value": "<any>"
    },
    "seller_offered_amount": {
      "currency_code": "<any>",
      "value": "<any>"
    },
    "offer_type": "REFUND",
    "history": [
      {
        "offer_time": "<string>",
        "actor": "BUYER",
        "event_type": "PROPOSED",
        "offer_type": "REFUND",
        "offer_amount": {
          "currency_code": "<any>",
          "value": "<any>"
        },
        "notes": "<string>",
        "dispute_life_cycle_stage": "INQUIRY"
      }
    ]
  },
  "refund_details": {
    "allowed_refund_amount": {
      "currency_code": "<any>",
      "value": "<any>"
    }
  },
  "communication_details": {
    "email": "<string>",
    "note": "<string>",
    "time_posted": "<string>"
  },
  "supporting_info": [
    {
      "notes": "<string>",
      "documents": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "source": "SUBMITTED_BY_BUYER",
      "provided_time": "<string>",
      "dispute_life_cycle_stage": "INQUIRY"
    }
  ],
  "allowed_response_options": {
    "acknowledge_return_item": {
      "acknowledgement_types": [
        "ITEM_RECEIVED"
      ]
    },
    "accept_claim": {
      "accept_claim_types": [
        "REFUND"
      ]
    },
    "make_offer": {
      "offer_types": [
        "REFUND"
      ]
    }
  },
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Path Parameters

​
id
string
required

The ID of the dispute for which to provide the supporting information.

Required string length: 1 - 255

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows dispute details.

The dispute details.

​
dispute_id
string

The ID of the dispute.

Required string length: 1 - 255
​
create_time
string<ppaas_date_time_v3>

The date and time when the dispute was created, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.

Required string length: 20 - 64
​
update_time
string<ppaas_date_time_v3>

The date and time when the dispute was last updated, in Internet date and time format. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.

Required string length: 20 - 64
​
disputed_transactions
Transaction Information · object[]

An array of transactions for which disputes were created.

Required array length: 1 - 1000 elements
​
reason
enum<string>

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#dispute-reasons">dispute reasons</a>.

Available options:
MERCHANDISE_OR_SERVICE_NOT_RECEIVED,
MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED,
UNAUTHORISED,
CREDIT_NOT_PROCESSED,
DUPLICATE_TRANSACTION,
INCORRECT_AMOUNT,
PAYMENT_BY_OTHER_MEANS,
CANCELED_RECURRING_BILLING,
PROBLEM_WITH_REMITTANCE,
OTHER
​
status
enum<string>

The overall status of the dispute, constant for all the parties involved at anytime during the dispute lifecycle.

Available options:
OPEN,
WAITING_FOR_BUYER_RESPONSE,
WAITING_FOR_SELLER_RESPONSE,
UNDER_REVIEW,
RESOLVED,
OTHER
​
dispute_amount
object

The amount in the transaction that the customer originally disputed. Because customers can sometimes dispute only part of the payment, the disputed amount might be different from the total gross or net amount of the original transaction.

​
dispute_asset
object

The asset in the transaction that the customer disputed.

​
fee_policy
object

Policy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process.

​
external_reason_code
string

The code that identifies the reason for the credit card chargeback. Each card issuer follows their own standards for defining reason type, code, and its format. For more details about the external reason code, see the card issue site. Available for only unbranded transactions.

Required string length: 1 - 2000
​
dispute_outcome
object

The outcome of a dispute.

​
adjudications
Adjudication · object[]

The Teammate Adjudication details for the dispute.

Required array length: 1 - 10 elements
​
money_movements
Money movement · object[]
deprecated

DEPRECATED The Money movement details for the dispute.

Required array length: 1 - 50 elements
​
fund_movements
Fund movement · object[]

The movements of fund due to the dispute.

Required array length: 1 - 50 elements
​
dispute_life_cycle_stage
enum<string>

The stage in the dispute lifecycle.

Available options:
INQUIRY,
CHARGEBACK,
PRE_ARBITRATION,
ARBITRATION
​
dispute_channel
enum<string>

The channel where the customer created the dispute.

Available options:
INTERNAL,
EXTERNAL,
ALERT
​
messages
Message · object[]

An array of customer- or merchant-posted messages for the dispute.

Required array length: 1 - 1000 elements
​
extensions
object

The extended properties for the dispute. Includes additional information for a dispute category, such as billing disputes, the original transaction ID, and the correct amount.

​
evidences
Evidence · object[]

An array of evidence documents.

Required array length: 1 - 100 elements
​
buyer_response_due_date
string<ppaas_date_time_v3>

The date and time by when the customer must respond to the dispute, in Internet date and time format. If the customer does not respond by this date and time, the dispute is closed in the merchant's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.

Required string length: 20 - 64
​
seller_response_due_date
string<ppaas_date_time_v3>

The date and time by when the merchant must respond to the dispute, in Internet date and time format. If the merchant does not respond by this date and time, the dispute is closed in the customer's favor. For example, yyyy-MM-ddTHH:mm:ss.SSSZ.

Required string length: 20 - 64
​
offer
object

The merchant-proposed offer for a dispute.

​
refund_details
object

The refund details.

​
communication_details
object

The contact details that a merchant provides to the customer to use to share their evidence documents.

​
supporting_info
Supporting Info · object[]

An array of all the supporting information that are associated to this dispute.

Required array length: 1 - 100 elements
​
allowed_response_options
object

The allowed response options for the buyer/seller update actions.

​
links
Link Description · object[]

An array of request-related HATEOAS links.

Required array length: 1 - 10 elements
⌘I