Paypal
Steps to add Paypal as a Source on Reveal Optimize and Reconcile dashboards
To add Paypal on your Reveal Transactions dashboard, you have to complete the following steps:
- Create new API credentials on Paypal Account.
- Configure SFTP and get their credentials with the help of Paypal Customer Support
- Add Paypal Credentials on Reveal account
- Configure Webhook on your Paypal account
Step 1: Create new API credentials on Paypal Account :
- Log in to your Paypal Developer dashboard.
- Go to Apps & Credentials.
- Click on Create App, provide a name, and click again on Create App.
- In the next page, under Features , ensure the following are selected on Other Features:
- Customer Disputes
- Transaction Search History
Step 1.1 Gathering API credentials from Paypal
- 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 it in the corresponding fields in Reveal dashboard under Cient ID and Secret Key respectively.
Step 2: Setting up SFTP account
- Now, login to you 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.
- Please 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
Step 3: Adding Paypal credentials on Reveal account:
- 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: Please 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.
Step 4: Configuring Webhooks on 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 2.
- Select the following Webhook Events:
- Billing plan
- Billing subscription
- Checkout
- Customer-support chargeback
- Customer dispute
- Payments & Payouts
- Reporting report
- Click on Save.
Paypal - Read only permissions
To add Paypal on your Reveal Optimize dashboard, we will need the following information:
- Client ID
- Secret Key
- SFTP Username
- SFTP Password
- Alias
We have listed the steps you have to follow to gather these information from your Paypal account.
Instructions to fetch the Integration details needed from your Paypal account:
Creating a new App and Selecting the required permissions
- Log in to your Paypal Developer dashboard
- Go to Apps & Credentials
- Click on Create App and provide a name and click again on Create App
- In the next page, under Features , ensure the following are selected on Other Features:
- Customer Disputes
- Transaction Search History
Gathering API credentials from Paypal
-
You can find the Client ID and Secret Key here.
-
Copy the Key and Shared Secret and paste it in the corresponding fields in Reveal dashboard under CLient ID and Secret Key respectively.
-
Now, login to you 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.
- Copy the Username and password and paste them in the relevant sections in the Reveal dashboard.
- Finally create an alias to help you identify your integration, then hit Connect.
- After completing these steps, please reach out to our team for configuring webhooks in your Paypal account.
Please 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
Configuring NVP/SOAP Webhooks
If you are unsure of which Paypal version you are using, please complete this step also.
- Log in to your Paypal Developer dashboard
- Go to Apps & Credentials
- Click on Create NVP/SOAP webhook
- Go to Live Webhook features and click on Add new webhooks
- Select the following Webhook Events:
- Billing plan
- Billing subscription (Mandatory, especially if Subscriptions enabled.)
- Checkout (Mandatory)
- Customer-support chargeback (Mandatory)
- Customer dispute (Mandatory)
- Payments & Payouts (Mandatory)
- Reporting report (Mandatory)