Test Customer Disputes

The PayPal sandbox environment enables you to pass specific information in a request to trigger simulated negative test scenarios. The simulated responses mimic actual API responses without calling downstream services. You can handle these responses in your code to manage your customer’s experience.

For easy API development and testing, download the latest version of Postman. Then download the Disputes collection .

For concepts, see the Customer Disputes Overview.

Permissions

Before you can trigger a simulation, you need to Get Started setting up your development environment. Then, return to this page to conduct simulation testing.

Simulation method

To trigger a simulation for the Disputes API, you can use a path parameter in the request URI.

Use a path parameter in the request URI

Request

curl -X GET \
  https://api.sandbox.paypal.com/v1/customer/disputes?disputed_transaction_id=ERRDIS023 \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json'

Response

{
    "name": "FORBIDDEN",
    "message": "No permission for the requested operation.",
    "debug_id": "e90ec082e0e4d",
}

Test values

Use the following test values to trigger negative responses for these disputes actions:

• List disputes
• Show dispute details
• Send message to other party
• Make offer to resolve dispute
• Escalate dispute to claim
• Provide evidence
• Accept claim
• Acknowledge return item
• Appeal dispute

Note: Test values are case sensitive.

List disputes

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at GET /v1/customer/disputes?disputed_transaction_id={transaction_id}.

Show dispute details

Negative response test values

Use the JSON pointer method to simulate the following error responses at GET /v1/customer/disputes/{dispute_id}.

Send message to other party

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/send-message.

Make offer to resolve dispute

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/make-offer.

Escalate dispute to claim

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/escalate.

Provide evidence

Negative response test values

Use the path parameter in the request URI method to simulate the following error responses at POST /v1/customer/disputes/{dispute_id}/provide-evidence.

Accept claim

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/accept-claim.

Acknowledge return item

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/acknowledge-return-item.

Appeal dispute

Negative response test values

Use the path parameter in the request URI method to simulate the following response at POST /v1/customer/disputes/{dispute_id}/appeal.