Docs

PayPal

To add PayPal to your Reveal Transactions 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.

Step 1: Create new API credentials on PayPal Account

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

Step 1.1 Gathering API credentials from PayPal

  1. You can find the Client ID and Secret Key in the Apps & Credentials section from Step 1.
  2. Copy the Key and Shared Secret, and paste them in the corresponding fields in the Reveal dashboard under Client ID and Secret Key respectively.

Step 2: Setting up SFTP account

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

Step 3: Adding PayPal credentials on Reveal account

  1. Log in to your Reveal account.
  2. Navigate to Sources tab > Add Source > PayPal.
  3. 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.
  4. SFTP Credentials: Copy the Username and password from Step 2 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.

Step 4: Configuring Webhooks on your PayPal Account

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

PayPal - Read-Only Permissions

To add PayPal to your Reveal Optimize dashboard, you need the following information:

  1. Client ID
  2. Secret Key
  3. SFTP Username
  4. SFTP Password
  5. Alias

Follow these steps to gather this information from your PayPal account.

Instructions to fetch the integration details from your PayPal account

Creating a new App and selecting the required permissions

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

Gathering API credentials from PayPal

  1. You can find the Client ID and Secret Key here.

  2. Copy the Key and Shared Secret and paste them in the corresponding fields in the 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 and password. This is your SFTP Username and password.

  1. Copy the Username and password and paste them in the relevant sections in the Reveal dashboard.
  2. Finally, create an alias to help you identify your integration, then click Connect.
  3. After completing these steps, reach out to our team for configuring webhooks in your PayPal account.

Contact your PayPal customer care and ensure that the following reports are generated and added to your SFTP automatically:

  1. Transaction Detail Report
  2. Case Report
  3. Settlement Report

Configuring NVP/SOAP Webhooks

If you are unsure of which PayPal version you are using, complete this step as well.

  1. Log in to your PayPal Developer dashboard.
  2. Go to Apps & Credentials.
  3. Click on Create NVP/SOAP webhook.
  4. Go to Live Webhook features and click on Add new webhooks.
  5. Select the following Webhook Events:
    • Billing plan
    • Billing subscription (Mandatory, especially if Subscriptions enabled)
    • Checkout (Mandatory)
    • Customer-support chargeback (Mandatory)
    • Customer dispute (Mandatory)
    • Payments and Payouts (Mandatory)
    • Reporting report (Mandatory)

Was this article helpful?