In this documentation, we provided all the setup and installation instructions you need to do, as well as configuring the PayPal Sandbox Testing for the PayPal Adaptive Payments Plugin. If you haven’t acquired the plugin yet, please also visit the plugin’s download site.
Unfortunately, PayPal no longer accepts new application for PayPal Adaptive payments gateway. PayPal Adaptive payments gateway can still be used by existing users but not by new users anymore. We are currently investigating this, so if you are interested to be notified when an alternative solution becomes available, kindly drop us an email.
What to check before purchasing
The following are the things you need to have before purchasing and using this plugin.
- Check whether your country is supported by PayPal
- Approved account by PayPal – you can contact PayPal Support through the following links: Link 1 | Link 2
- Commissions Plugin installed in your website
- PayPal Business account
Setup and Installation
Before proceeding with the installation, you must by now have an approved PayPal Account or else you can’t use this plugin at all. Next steps are:
- Go to your WordPress Dashboard. Select Plugins on the left and Add New.
- Select Upload Plugin.
- Select the Browse Button to install the zip file with the plugin.
- Activate the plugin if needed.
Then, go to Downloads > Settings > Payment Gateways > General. Tick PayPal Adaptive Payments as your Payment Gateway. You can also set it as your Default Gateway.
Further below, you can tick the box of which Accepted Payment Method Icons will show in your Checkout Page.
a) Once your application is approved and have the plugin installed in your WordPress website, go to gateway settings in Downloads → Settings → Payment Gateways → PayPal Adaptive Payments. You can then see the following details that needed to be filled out.
Note: You can get your API Credentials by visiting your PayPal Profile → API Credentials tab and fill out the necessary details in the PayPal Adaptive Payments settings.
- PayPal Adaptive Payments License Key – Enter your license key that will be provided upon purchase of this plugin.
- Live API Username, Live API Password and Live API Signature – Fill these sections by the details from your API Credentials located at your PayPal Profile.
- Live APP ID – You can get this by creating an account at www.x.com and registering a new APP.
- Test API Username, Test API Password, Test API Signature and Test APP ID – Only needs to be filled out when testing the plugin and by using a Sandbox Account. If not, just leave these fields empty.
b) In order to actually split up your payments, you will need to add in your receivers email in the section below the API Credentials. Just add each receiver email to a new line with a pipe bracket “|” separating the percentage you want to go to that account.
NOTE: If you are using Chained Payments, these accounts must be verified PayPal accounts or the transaction will not work.
c) You can choose your Payment Type as well. The options available are Chained Payments and Parallel Payments.
- Chained Payments: Your Store accepts the entire payment and secretly pays commissions to Vendors after the sale.
- Parallel Payments: The customer knows everyone who will receive payment upon checkout – as the payments are split visually at checkout.
d) The last option is to set whether you want to require a Pre-Approval before actually charging the customer. If this is enabled, the customer will authorize the charge and you will have up to a year to submit the charge before the customers approval will be cancelled.
NOTE: If you have enabled Pre-Approvals, you will be able to approve the payments inside the Payment History section, under the Preapproval Pending status.
For more information, visit the Introducing Adaptive Payments.
Splitting Commissions automatically
By using PayPal Adaptive Payments plugin, expect that each of your respective vendor will receive their commission automatically. Now, how can we configure our receivers?
Vendor Profile Form
Please ensure you activate the PayPal field (coming from this plugin) in the Menu FES / Registration Form. All vendors will need to enter a valid PayPal Email address, otherwise the payments will not come through.
Defining Vendor Commission Rates
The way this plugin works is that the commission settings (coming from the Commissions Plugin) overrule the general plugin settings. So for every product download, you can basically define different commission recipients. Take note that the split can be set individually by product.
Now, the plugin settings should only include 1 hard-coded recipient.
Above settings will split the sale in the ratio 10 / 5 / 85 automatically upon purchase. The customer will only see the PayPal address of the admin appears while the PayPal email addresses of the other commission receivers will remain hidden. We recommend to not only test this on the PayPal Sandbox but also do 2-3 test purchases on the live environment (with low amounts) to verify that this works correctly.
How to test if PayPal Adaptive Payments really works?
After having this plugin installed and configured, we can conduct a test and see if this plugin properly works just to be sure and which prevents us from future problems. We can try either tests: (1) testing via a live paypal account or (2) testing with a sandbox account.
(1) Testing via Live PayPal Account
For website starters, you can save yourself time by testing the plugin using a Live PayPal Account. This way, you only need to test once which prevents additional time-consuming work needed when conducting the first test with PayPal Sandbox.
In order to do live testing of this plugin, you can simply follow the steps above to configure the plugin first, then use a Test Live PayPal account to simulate test purchase and see if this plugin works correctly.
(2) Testing via a Sandbox Account
If you are currently operating a webstore with a huge amount of traffic and is using a different payment gateway, you might need an extensive and careful testing first to prevent problems and complications with your customers.
We then recommend you to try testing using PayPal Sandbox Account first. In order to do this, you can follow the steps below before logging in with PayPal Sandbox and conducting some test purchase to see if this plugin works perfectly.
Test Mode Configuration
Go to https://developer.paypal.com and log in using a Paypal Business Account.
Step 1: Set up your developer account with Paypal.
b. Make sure to switch the account type to “Business”. Fill out your name, password, and email. Leave all other settings as-is.
c. At the bottom of the page click “Create Account”.
d. Also create a test buyer account so you can do a test purchase. Set your “Buyer” account to be a “Personal” account. You will also do this here: https://developer.paypal.com/developer/accounts/.
Step 2: Copy your API credentials into WordPress
a. In a separate Browser tab, load up your WordPress dashboard where you have Easy Digital Downloads – Paypal Adaptive Payments activated/installed.
b. Go to “Dashboard” → “Downloads” → “Settings” → “Payment Gateways” → “Paypal Adaptive Payments”.
c. Go back to your original browser tab and load: https://developer.paypal.com/developer/accounts/.
d. Click on the email address you used to create the test account.
e. In the “pop-down” after clicking, click on “Profile”
f. In the “Pop-Up” click the “API Credentials” tab.
g. Locate the “Username”, “Password”, and “Signature” and copy each to your WordPress under “Test API Username”, “Test API Password”, and “Test API Signature”.
h. Under “Test APP ID” enter “APP-80W284485P519543T”.
Common Errors and Solutions
Paypal Adaptive Payments is one of the most complex payment gateways to properly configure. There’s a good chance that you’ll run into an error message while getting setup. This is normal. If you run into one of the following errors, try each of the listed solutions to make sure you have configured everything correctly.
Frequently Asked Questions
If you face any problem installing and bringing this plugin to work, please contact us via support and we will get back to you within 24 hours.