Documentation Index
Fetch the complete documentation index at: https://docs.paypal.ai/llms.txt
Use this file to discover all available pages before exploring further.
Use these procedures to configure your PayPal business and sandbox accounts to manage disputes in the Resolution Center or to integrate with the Disputes API.
You can use the procedures in this section to ensure that your accounts and environment are set up to manage disputes.
Set up sandbox account
Resolution Center
Disputes API
Use this path if you only need to test and manage disputes manually through the PayPal Resolution Center without integrating the Disputes API.
- Sign up for a developer account. On successful signup, PayPal automatically creates your sandbox environment. The sandbox environment is a test environment that helps you mimic real-world transactions.
- Retrieve sandbox account credentials to log in to your PayPal sandbox account and access the Resolution Center. To do this:
- Select Sandbox Accounts. By default, the environment includes a business and personal account. To create more sandbox accounts, you can select Create account.
- Locate the account for which you want to get credentials, and select
⋮.
- Select View/Edit Account to view the account email address and the system-generated password.
- Sign in to your PayPal sandbox account using the personal sandbox credentials. In a separate browser session, sign in with the business sandbox credentials. When you test dispute workflows, use the personal account to create disputes and the business account to handle them. Verify the dispute status in both accounts.
Use this path if you plan to integrate the Disputes API and test automated dispute handling end to end.
-
Sign up for a developer account. On successful signup, PayPal automatically creates your sandbox environment. The sandbox environment is a test environment that helps you mimic real-world transactions. By default, the environment includes a business and personal account. When testing your app, you can use the personal account to create disputes and the business account to handle them. You can create additional business and personal accounts.
-
Set up the sandbox environment:
-
Go to your PayPal developer account and toggle to Sandbox.
-
Go to Apps & Credentials and select Create App.
-
Enter your app name, select Type as Merchant, select the sandbox business account to test your app, and select Create App. The app details page is displayed.
-
Go to Features > Add-on services. By default, the Customer disputes checkbox is selected. If not, select it.
-
Optional: Configure a webhook listener for the app and subscribe to events:
- In the app details page, go to Sandbox Webhooks.
- Select Add Webhook.
- Enter a Webhook URL (the server endpoint where notifications from PayPal are sent), select the events the app wants to subscribe to, and select Save.
- The webhook listener is successfully configured, and a Webhook ID is displayed. You can store the ID and use it in your app code to verify the source sending messages to your listener.
For more information on webhooks, see Webhooks guide. For the list of disputes events that the app can subscribe to, see Webhook reference.
-
Retrieve sandbox app credentials: To integrate and test the Disputes API, you need the sandbox credentials (Client ID and Client secret) for your app. To retrieve them, see Get your client ID and client secret.
-
Get an access token: To authenticate your API calls, get an access token using your client ID and client secret. For more information, see Get started with PayPal REST APIs
-
Retrieve sandbox account credentials: When you test your disputes integration end-to-end, you log in to your PayPal personal account, create a dispute, handle it through your PayPal business account, and check the dispute status in both accounts. You need sandbox login credentials for both accounts. For information on how to get these from your developer account, see Get sandbox account credentials.
-
Set up the development environment. This involves building your server, installing dependencies, verifying configuration files that the package managers use, and setting up the environment variables.
Set up buyer-side credentials
The procedures in this section apply only to the test simulations of the Disputes API.
- Configure your REST app.
- Get buyer consent for your sandbox personal account.
- Use PayPal-Auth-Assertion request header when you make API calls to create disputes or change dispute reasons as a buyer.
Contact your PayPal account manager to add the following scopes to your REST app:| Scope name | Scope | Description |
|---|
DISPUTE_CREATE | https://uri.paypal.com/services/disputes/create | Scope to create a dispute. |
UPDATE_BUYER | https://uri.paypal.com/services/disputes/update-buyer | Scope to change the dispute reason. |
Get buyer consent
You need to obtain buyer consent to create disputes or change dispute reasons on behalf of your sandbox personal account (buyer) using the Disputes API. To do this:
- Create a Log in with PayPal button:
- Complete the steps to Enable Log in with PayPal in your PayPal developer account.
- Complete the steps to Generate button. When you do this, you can configure the following options:
application ID (client ID) as your app’s client ID.container ID as lippButton.auth end point as sandbox. Confirm this is set to sandbox, as the field may default to production.scope as either https://uri.paypal.com/services/disputes/create or https://uri.paypal.com/services/disputes/update-buyer.return URL should match the one configured for your REST app in the previous step.
- Run your application.
- Under Features > Add-on Services, select the Log in with PayPal on your application.
- Log in with your sandbox personal account credentials as a buyer and approve the consent.
During the API test simulation, include the PayPal-Auth-Assertion request header in API calls to create disputes or change dispute reasons as a buyer.Generate the JSON Web Token (JWT) and pass it in this request header to identify the buyer.Generate JWT for PayPal-Auth-Assertion
Replace the following in the HTML code provided:
CLIENT_ID with your app’s client ID.BUYER_EMAIL with the buyer’s email address.
Run this code in any HTML sandbox environment or save it as an HTML file and open it in a browser. This generates a JWT that you can use in the PayPal-Auth-Assertion request header.<span id='cwppButton'></span>
<html>
<script>
function base64url(source) {
var encodedSource = btoa(source);
encodedSource = encodedSource.replace(/=+$/, '');
encodedSource = encodedSource.replace(/\+/g, '-');
encodedSource = encodedSource.replace(/\//g, '-');
return encodedSource;
}
function generateJWT() {
var header = {"alg": "none", "typ": "JWT"};
var data = {"iss":"CLIENT_ID", "email" : "BUYER_EMAIL" };
document.write(base64url(JSON.stringify(header)) + "." +
base64url(JSON.stringify(data)) + ".");
}
</script>
<body onload="generateJWT()"/>
</html>
Common issues
Issue: PayPal-Auth-Assertion header is ignored or rejected.
Fix: Verify that the JWT contains the correct CLIENT_ID and BUYER_EMAIL, and that you are using the sandbox personal account email for the buyer. Set up live account
Resolution Center
Disputes API
Use this path to manage disputes manually in production without building an API integration.Log in to your PayPal business account at the PayPal Business Dashboard. No additional setup or configuration is required to use the Resolution Center in the live environment. Use this path when you are ready to move your Disputes API integration from sandbox to production.Partners: To set up a partner account with connected integration, complete
this form. A PayPal representative will reach out to you. You can work with them to configure your Live account. Use the following procedure after your Live account is configured.
-
Log in to your PayPal business account at the PayPal Developer Dashboard.
-
Switch to the Live environment.
-
Go to Apps & Credentials and create a new app or select an existing app.
-
Go to Features > Other features. By default, the Customer disputes checkbox is selected. If not, select it.
-
Optional: Configure a webhook listener for the app and subscribe to events:
- On the app details page, go to Live Webhooks.
- Select Add Webhook.
- Enter a Webhook URL (the server endpoint where notifications from PayPal are sent), select the events the app wants to subscribe to, and select Save.
- The webhook listener is successfully configured, and a Webhook ID is displayed. You can store the ID and use it in your app code to verify the source sending messages to your listener.
For more information on webhooks, see Webhooks guide. For the list of dispute events that the app can subscribe to, see Webhook reference.
-
Copy your Client ID and Secret for the live app.
-
Optional: To download the files submitted as evidence, contact your PayPal account manager to add the following scopes to your REST app:
- In scopes -
DOCUMENTS_DISPUTES_DOWNLOAD
- In claims -
dms_data_access_rule:all_of and dms_data_access_fields:account_number
