New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now
Docschargebee docs
HomeBillingCPQPaymentsRevRecGrowthReveal
Support

Introduction

  • Overview

Transactions

  • Get Started
    • Adyen
    • Braintree
    • PayPal
      • PayPal Read-Only Permissions
    • Shopify Payments
    • Stripe
  • Insights
  • Understand Payment Performance
  • Alerts

Settlements

  • Get Started
    • Adyen
    • Braintree
    • PayPal
      • PayPal Read-Only Permissions
    • Shopify Payments
    • Stripe
  • Reconciliation
  • Fees
  • Records

Data Security

  • Data Control
  • PII Data
  • Card Vaulting
  • Data Policies, Processes and Methods

Glossary

  • Standard Terms
  1. Reveal
  3. Settlements
  5. Get Started
  6. PayPal
  1. Reveal
  3. Settlements
  5. Get Started
  6. PayPal

PayPal

Why connect PayPal for Settlements

Connect PayPal as a source so Reveal can import settlement and payout data from your PayPal business account into Settlements. After the connection is complete, Reveal imports historical settlement data and keeps it current so you can:

  • Trace funds from customer payment to bank deposit
  • Reconcile settlement batches against bank entries and monitor unsettled volume
  • Analyze processing fees and inspect settled transaction records

The same PayPal source can also feed Transactions for authorization, decline, and dispute analytics. Connecting PayPal does not change how PayPal processes payments or pays out funds. Reveal reads settlement and report data; it does not modify live payment flows.

See Get started with Settlements for the overall connection workflow. If your goal is authorization performance rather than reconciliation, see Connect PayPal for Transactions.

How the PayPal Settlements guide differs from read-only permissions

This page is the connection guide for PayPal in Settlements. 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 on your Reveal Settlements dashboard, complete the following steps:

  1. Create new API credentials on PayPal Account.
  2. Configure SFTP and get their credentials with the help of PayPal Customer Support.
  3. Add PayPal Credentials on Reveal account.
  4. Configure Webhook on your PayPal account.

Creating 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.

  1. Log in to your PayPal Developer dashboard.
  2. Go to Apps & Credentials.
  3. Click on Create App, provide a name, and click again on Create App.
  4. In the next page, under Features, ensure the following are selected on Other Features:
    • Customer Disputes
    • Transaction Search History

Retrieving API credentials from PayPal

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.

  1. You can find the Client ID and Secret Key here.
  2. Copy the Key and Shared Secret and paste it in the corresponding fields in Reveal dashboard under Client ID and Secret Key respectively.
  3. Now, log in to your PayPal Business Account > Account Settings > Account Access > Secure FTP. If there is no user create a user & password. This is your SFTP Username and password.
  4. Copy the Username and password and paste them in the relevant sections in the Reveal dashboard.
  5. Finally create an alias to help you identify your integration, then click Connect.
  6. After completing these steps, reach out to our team for configuring webhooks in your PayPal account.

Ensure that you 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

Setting 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.

  1. Now, log in to your PayPal Business Account > Account Settings > Account Access > Secure FTP.
  2. If there is no user, create a user & password.
  3. This is your SFTP Username and password.
  4. Ensure that you 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

Adding PayPal credentials in Reveal

  1. Log in to your Reveal account and navigate to Sources tab > Add Source > PayPal.
  2. API Credentials: Copy Client id and Secret Key as mentioned in Step 1.1 and paste them in the respective fields in your Reveal dashboard.
  3. SFTP Credentials: Copy the Username and password from Step 2 and paste them in the relevant sections in the Reveal dashboard.
  4. Finally create an alias to help you identify your integration, then click Connect.

Configuring webhooks in PayPal

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.

  1. In your Reveal account, navigate to the Sources page.
  2. The PayPal source you added will now be visible.
  3. Copy the webhook URL listed next to the PayPal account you just added by clicking the copy icon beside it.
  4. Log in to your PayPal Developer dashboard.
  5. Go to Apps & Credentials and click on Create NVP/SOAP webhook.
  6. Go to Live Webhook features and click on Add new webhooks.
  7. Paste the webhook URL you copied from step 2.
  8. Select the following Webhook Events:
    • Billing plan
    • Billing subscription
    • Checkout
    • Customer-support chargeback
    • Customer dispute
    • Payments and Payouts
    • Reporting report
  9. Click on Save.

Take the next step with PayPal in Settlements

  • PayPal read-only permissions — Collect the REST app features, Client ID, Secret Key, and SFTP report credentials Reveal needs.
  • Get started with Settlements — Connect other processors and see what happens after data loads.
  • Reconciliation — Trace payouts after PayPal settlement data is available.
  • PayPal for Transactions — Connect the same PayPal account for authorization and decline analytics if you also use Transactions.

Was this article helpful?