View Product Page

Payout API settings

How the plugin works

For every completed order, the receivers that you’ve previously set will get a percent commission calculated on the order subtotal amount.

Let’s consider, for example, an order worth €100, with 2 eligible receivers, one has a 50% commission rate, the other one has a 20% commission rate.

As soon as the order acquires the status Completed, two payments will be issued from the admin PayPal account, the first one is worth €50 and the second one is worth €20.

Now, let’s see how to configure all the API settings in the right way.

In order to work properly, opcache.save_comments must be set at 1 in php.ini file of your server.

Configuration

To start using your PayPal account to pay percent commissions to your partners, you will have to create a Payouts app.

Once you are in your PayPal account, make sure you create a REST API app or use one you’ve already created.

Here, you will find your Client ID and Secret KEY in your REST API app.

These are the keys that you have to add in the plugin settings. So, go to General settings > Payouts API settings:


Payouts API settings
  • PayPal business email: enter your business PayPal email to use the payouts service. You can find it inside your Payouts applications settings in developer.paypal.com.
  • Application Client ID: enter the key you find under Client ID.
  • Application Client KEY: enter the key you find under Secret.

Let’s see the other option available in this section:

Sandbox mode
  • Enable Sandbox Mode: enable this option if you want to test the plugin with a sandbox PayPal account first, so no real transaction will be made. If you want to create a sandbox account, please, refer to PayPal official documentation.

IMPORTANT: By default, Payouts is enabled in the sandbox environment. Merchants in the U.S. with a business account can enable Payouts in the live environment. Please, refer to PayPal official documentation for more information.


Extra & GDPR

In the General settings section, you can also set two additional sets of options:

Extra

Extra
  • Enable Log: enable this option to see the error log during debugging. Remember to disable it when your website is regularly running.
  • Webhook Configuration: here you can find the URL you must enter in your PayPal account setting to issue the payments correctly. To set it up, click on Add Webhook in your PayPal account and paste the URL into the Webhook URL there:
Create app
Webhook-URL

Then, select all PayOuts events as shown in the following image:

Payout events

In the Live App settings, check if Payouts is checked like this:

Live app

And then in My Account check that your account is a business account , and then the Payouts item has the “green check”.

If it displays the “enable” text, just click on the link and send a message to PayPal to get it enabled:

Enable

Once completed, press Save and you’re done.

GDPR

In order to comply with the GDPR (General Data Protection Regulation), the plugin includes a dedicated section in the plugin settings from which you can decide what to do with the information managed by YITH PayPal Payouts.

GDPR options
  • Export payouts in personal data export requests: when enabled, this option allows users to export information about their own payouts when they submit an account personal data export request.
  • When handling an account erasure request: this option allows you to choose what to do when a user submits an account erasure request. You can
    • Remove user ID and PayPal email from the receivers list
    • Remove the PayPal email from receivers payouts.

For what concerns all the other user information, please, refer to WordPress main page under Tools > Export Personal Data and/or Erase Personal Data.