General 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 goes to Completed status, two payments will be issued from the admin PayPal account, the first one is worth €50 and the second one is worth €20.

But let’s see how to configure all the plugin options the right way.

In order to works 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 cooperators, you first have to configure PayPal Payouts for your shop.

Go to YITH Plugins > PayPal Payouts.

General settings

PayPal business email: enter here your PayPal account email address. This is the account from where payments to the receivers will be issued.

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

Enter then your PayPal API credentials into the plugin settings. You will find your Client ID and Secret KEY in your REST API app.

Application Client ID: enter here the key you find in under Client ID

Application Client KEY: enter here the key you find under Secret

Enable Sandbox Mode: Enable this option if you want to test this 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.

Enable Log: enable this option if you want to see the error log during debugging. Remember to disable it when your website is regularly running.

Exclude Vendor Product from Payouts calculation: only available when Multi Vendor plugin is enabled. This option allows you to exclude vendor products from Payouts operations. Only products associated with no vendors are eligible for creating commissions for your receivers. Read more about this integration on this page.

Webhook Configuration: here you find the URL that you have to enter in your PayPal account setting in order to make the payments be issued correctly. To set it up, click on Add Webhook in your PayPal account and paste the URL into the Webhook URL there:

Webhook-URL

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

payout-events

Press on Save and you’re done.