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.

Payouts receivers settings

From the plugin settings panel, click on the tab called Payout Receivers Settings to add all the people you want to share profits with.

Make sure the receiver you want to add has already registered to your website, as you can only add existing users to this page.

Click on Add new Receiver, start typing the username and select it. Enter then his/her PayPal Email address, which is where the payments will be sent to. Finally, enter the commission percentage.

Please, note: when you set the commission percentage, make sure it is a reasonable percentage as this commission will be calculated out of the order subtotal, excluding taxes. Yet, every transaction processed by PayPal has fees, so, make sure you consider all the expenses when you set this commission rate.

Payout Receivers Settings

If you want to read more about PayPal commission fees on transactions, please, refer to PayPal official documentation.

Payouts List

In the following section, Payouts List, you will find all the payouts you have issued so far.

They are listed in batches and grouped by order. On the first column, you find the reference order, followed by the Payout Batch ID.

Payouts list

IMPORTANT: Please, consider that the payouts will only be issued when the order status goes to completed.

The third column of the table shows the current status of the payout batch. It can be one of the following:

  • unprocessed: you will see the status when no payment has been made yet and the order hasn’t gone to completed status yet.
  • pending: this is a temporary status that appears when the transaction hasn’t been processed yet.
  • processing: this is the status that the batch payment takes when the payments are being processed.
  • success: the payout batch take on this status when all payments have been correctly issued to all receivers.

Payout Mode column: it refers to the type of payment that is linked to the batch. It can take on the following statuses:

  • Instant: this is the default status you will see when the plugin is used to pay a percentage on every order to all the receivers.
  • Affiliate: this status appears when the Payout payment is related to an affiliate commission generated through YITH WooCommerce Affiliates plugin.
  • Commission: this status appears when the Payout payment is related to a vendor commission generated through YITH WooCommerce Multi Vendor plugin.

Payout Details: click on this button to see the detail of the Payout batch and all transactions included in it.

This is an example of how a batch looks like:

Payout details

There are two payouts listed under the same order because there are two receivers set for shop payouts.

If you use this plugin in combination with Multi Vendor or Affiliates, there might be more transactions in the same batch than the listed receivers.

By clicking on the “eye” icon in the last column of Payout Details, you will get to see a popup with the Payout item details:

popup

Receiver’s transaction list

If the admin can keep track of all the payments issued to the receivers on in the plugin settings in the Payouts List tab, each receiver will be able to check their own payouts on the frontend, in a dedicated section in My Account page.

They will find a menu item called Payouts. Here they find a list with all transactions they have received.

The table includes a reference to the Payout item ID, the Transacton ID, the Transaction status and the amount.

Transaction list on the frontend

Privacy Settings

In order to comply with the GDPR (General Data Protection Regulation), this plugin includes a dedicated tab in the plugin settings. From this page, you can decide what to do with the information managed by YITH PayPal Payouts plugin. Please, refer to

Privacy settings

The first option, Export user’s payouts, allows users to export information about their own payouts when they submit an account personal data export request.

The following section, Personal Data Eraser, allows you to choose what to do when a user submits an account erasure request. You can check the following boxes:

User data: this removes the user’s PayPal email address from your website.

PayOuts: this removes the user’s PayPal email address from the payouts details saved on your website.

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

YITH WooCommerce Affiliates

This plugin allows you to pay all the commissions that are generated by your affiliates if you use the premium version of YITH WooCommerce Affiliates.

In order to enable the two plugins to work together, make sure both of them are installed and activated.

Whenever an affiliate drives a sale to your shop, you will see the list of commissions under YITH Affiliates > Commissions.

Based on the settings of your affiliate payments, the plugin allows manual and automatic payment of affiliate commissions.

1. Manual payment

If you have selected the manual payment of affiliate commissions,  every sale driven by an affiliate to your store will appear as in the following screenshot.

Affiliates - commissions

Next to each commission you will find some buttons that perform different actions. Among them you find the option to pay the commission via PayPal Payouts. Just click on it to pay one specific commission.

As an alternative, you can bulk select more than one commission and process the same action for all of them.

2. Automatic payment

If you have selected the manual payment of affiliate commissions,  every sale driven by an affiliate to your store will appear as in the following screenshot.

Make sure you select PayPal Payouts and all payments will automatically go through it.

Affiliate payments in Payouts list

Once the payment is done, you will also be able to see this payment in your Payouts List. It will be easy to spot the payment of affiliate commission, as they are listed as Affiliate Payment for (followed by the affiliate payment ID) and will take on the affiliate status in the PayOut Mode column.

Payout list with statuses

 

YITH WooCommerce Customize My Account Page

YITH WooCoomerce Customize My Account Page helps you customize your “My Account” page in your website in a few simple step, adding new sections and editing the default WooCommerce ones.

payouts tab

Integrated with YITH PayPal Payouts for WooCommerce the endpoint with PayPal Payout content is automatically added to the my account page.

For more information on how to set up the Customize My Account Page plugin, check the complete documentation here.

YITH WooCommerce Multi Vendor

You can use YITH PayPal Payouts for WooCommerce to pay your vendors’ commissions instantly and automatically.

To start using it, make sure that the premium version of YITH WooCommerce Multi Vendor is installed and activated.

Then, go to the plugin settings under YITH Plugins > Multi Vendor > Payments.

Here you will find all the available payment gateways that you can use to pay vendors’ commissions.

Click on PayPal Payouts to enable it and make sure you save the changes.

You can now choose whether to pay commissions to vendors automatically during the checkout and pick the payment method you prefer among the available ones.

Open the dropdown next to Pay commissions to vendors during checkout and pick PayPal PayOuts.

This way, all commission payments will go through it automatically.

If, on the other side, you prefer paying commissions manually, just select Disabled on Multi Vendor payment settings page:

You will see the pending commissions in the Commissions page and the available payment method right next to it. Click on PayPal Payouts in the Actions column to pay the commission through it.

Exclude vendors’ products from Payouts commissions

If you want to avoid thta vendors’ products are included in the total calculation for your store’s receivers commissions, we suggest you keep this option enabled.

Go to YITH Plugins > PayPal PayOuts and make sure it is checked.

Suppose you get an order with 2 products. Product A belongs to vendor A and costs €60, product B does not belong to any vendor and costs €40, so the total order is worth €100. In addition to this, you have set one receiver with a 50% commission.

If the option is disabled, your receiver will get €50.

If the option is enabled, product A is excluded, so the receiver will get €20, which is 50% of product B price.

If you want to read more about Multi Vendor configuration settings, please, refer to the official plugin documentation.