PayPal
Why connect PayPal for Transactions
Connect PayPal as a source so Reveal can import payment activity from your PayPal business account into Transactions. After the connection is complete, Reveal imports historical data and continues to monitor live activity so you can:
- Track authorization and decline rates for PayPal
- Diagnose failures, including disputes and chargebacks
- Act on payment-performance changes from Insights and Alerts
The same PayPal source can also feed Settlements, so finance teams can reconcile payouts, track unsettled volume, and analyze processing fees. Connecting PayPal does not change how payments are processed. Reveal reads data from PayPal; it does not modify live payment flows.
See Get started with Transactions for the overall connection workflow. If your goal is payout reconciliation rather than authorization analytics, see Connect PayPal for Settlements.
How the PayPal Transactions guide differs from read-only permissions
This page is the connection guide for PayPal in Transactions. Use it to understand why you add PayPal as a source, then complete the workflow in Reveal: enter credentials, connect the source, and register the webhook URL.
PayPal read-only permissions is the PayPal-side checklist. Use that page to create the REST app, enable Customer Disputes and Transaction Search History, and collect the Client ID, Secret Key, SFTP username, and SFTP password. After you have those values, return here to add PayPal as a source.
Reveal needs these values to complete the connection:
- Client ID
- Secret Key
- SFTP Username
- SFTP Password
- Alias
To add PayPal to your Reveal Transactions dashboard, complete the following steps:
- Create API credentials in PayPal
- Set up SFTP credentials
- Add PayPal as a source in Reveal
- Configure NVP/SOAP webhooks
Create API credentials in PayPal
Note
PayPal's Developer Dashboard can change. Refer to How do I create PayPal REST API credentials? for the latest steps to create an app in Apps & Credentials, copy the Client ID and secret, and request app permissions such as Customer Disputes. The instructions in this section are a working guide for connecting Reveal.
Follow these steps to create API keys in your PayPal account:
- Log in to your PayPal Developer dashboard.
- Go to Apps & Credentials.
- Click on Create App, provide a name, and click Create App again.
- On the next page, under Features, ensure the following are selected under Other Features:
- Customer Disputes
- Transaction Search History
Retrieve credentials from PayPal
Follow these steps to retrieve the required credentials from your PayPal account:
- You can find the Client ID and Secret Key in the Apps & Credentials section from Step 1.
- Copy the Key and Shared Secret, and paste them in the corresponding fields in the Reveal dashboard under Client ID and Secret Key respectively.
Set up SFTP credentials
Note
PayPal's account settings can change. Refer to Access SFTP reports for the latest steps to create a Secure FTP user and subscribe to reports. The instructions in this section are a working guide for connecting Reveal.
Follow these steps to set up SFTP credentials in your PayPal account:
- Now, log in to your PayPal Business Account > Account Settings > Account Access > Secure FTP.
- If there is no user, create a user and password. This is your SFTP Username and password.
- Contact your PayPal customer care and ensure that the following reports are generated and added to your SFTP automatically:
- Transaction Detail Report
- Case Report
- Settlement Report
Add PayPal as a source in Reveal
Follow these steps to add PayPal as a source in your Reveal dashboard:
- Log in to your Reveal account.
- Navigate to Sources tab > Add Source > PayPal.
- API Credentials: Copy the Client ID and Secret Key as mentioned in Step 1, and paste them in the respective fields in your Reveal dashboard.
- SFTP Credentials: Copy the Username and password from Step 2 and paste them in the relevant sections in the Reveal dashboard.
- Finally, create an alias to help you identify your integration, then click Connect.
Configure PayPal webhooks
Note
PayPal's Developer Dashboard can change. Create the NVP/SOAP webhook and add the Reveal listener URL from Apps & Credentials. The instructions in this section are a working guide for connecting Reveal.
Follow these steps to configure webhooks in your PayPal account:
- In your Reveal account, navigate to the Sources page.
- The PayPal source you added will now be visible.
- Copy the webhook URL listed next to the PayPal account you just added by clicking the copy icon beside it.
- Log in to your PayPal Developer dashboard.
- Go to Apps & Credentials and click on Create NVP/SOAP webhook.
- Go to Live Webhook features and click on Add new webhooks.
- Paste the webhook URL you copied from step 3.
- Select the following Webhook Events:
- Billing plan
- Billing subscription
- Checkout
- Customer-support chargeback
- Customer dispute
- Payments and Payouts
- Reporting report
- Click on Save.
Take the next step with PayPal in Transactions
- PayPal read-only permissions — Collect the REST app features, Client ID, Secret Key, and SFTP report credentials Reveal needs.
- Get started with Transactions — Connect other processors and see what happens after data loads.
- Insights — Review authorization health after PayPal data is available.
- PayPal for Settlements — Connect the same PayPal account for reconciliation and fees if you also use Settlements.
Was this article helpful?