Note: This article relates to the PayPal Payouts pro add-on.

To send affiliate payouts using PayPal’s API, you will need to first create an “API Application”. This is simply a set of credentials you provide to Arabianaffiliates in order to allow Arabianaffiliates to send payment details to PayPal on your behalf.

Creating Your API Application
API Applications are created from the My Apps of the PayPal Developer portal. Don’t worry, you do not need to be a developer to create the application.

Log in with your normal PayPal account credentials and then you will see a screen like this:

Click on Create App below REST API apps. On this next screen, enter “Arabianaffiliates – PayPal Payouts” as the App name. The Sandbox developer account option can be left as default, unless you’d like to use a specific Sandbox account for this application.

Once the application is created, click on the application name to view the details page of the application.

In the top right corner is a toggle button for viewing Sandbox vs. Live credentials. For testing PayPal Payouts, use the Sandbox credentials. When ready to process actual payments, use the Live credentials.

For live payouts, be sure to enable the Payouts permission from My Account.

Now, from your WordPress Dashboard, navigate to Affiliates → Settings → PayPal Payouts and enter your Client ID and Secret.

If you wish to test PayPal Payouts, you can enable Test Mode. This will cause Arabianaffiliates to use your Sandbox credentials so you can test payout processing without transferring actual funds.

Important Notes

PayPal Payouts requires API access and the payouts feature to be enabled in your PayPal account. Available for all business accounts.

If you receive a “denied” receipt from PayPal after processing a payout, the affiliate’s account may be suspended, cannot receive your site’s currency, or cannot receive payments from your country.

Be sure to have enough funds in your PayPal balance prior to paying out your affiliates.

Note: This article relates to the PayPal Payouts pro add-on.

The PayPal Payouts pro add-on gives you the ability to instantly pay your affiliates their earnings from your PayPal account using PayPal’s MassPay/Payout APIs. This document will walk you through how to use the add-on to pay your affiliates.

PayPal Payout Methods
There are two payout methods available:

API Application – See setup documentation
MassPay – See setup documentation
Using an API Application is the preferred method as it utilizes PayPal’s new REST API.

Note: Payouts is not enabled for all PayPal accounts. New accounts and those without much transaction history will need to get Payouts approved by PayPal merchant support. PayPal does not enable it on all accounts so please contact PayPal merchant support if you do not currently have access to Payouts.

PayPal MassPay is an older PayPal technology that is no longer available for most accounts. If your account has MassPay enabled, you are more than welcome to use it.

The payout method used can be set from Affiliates → Settings → PayPal Payouts.

Processing Payouts
Once you have entered your API credentials, all unpaid referral records will have a Pay Now action link available:

You can click Pay Now to process a payout for individual referral records. Arabianaffiliates will inform you of whether the payout was successful or if there was an issue:

Note: the affiliate must have a valid PayPal account tied to their email address to receive the payout. If the affiliate does not have a PayPal account they will receive a PayPal invitation to create an account. If the affiliate does not accept the invitation, the funds will be returned to your PayPal account.

If you prefer, you can also process payouts in bulk in one of two ways:

1. Check the box on the left side of the screen for each referral you wish to pay and then choose Pay Now from the Bulk Actions menu. This will process a payment for each referral selected.

2. Generating a bulk payment using the blue Bulk Pay via PayPal button. This allows you to specify a date range and a minimum amount that affiliates need to have accumulated in order to be paid. Arabianaffiliates will calculate the amount due to each affiliate and then send the amount as a single payment, marking each of the included referrals as Paid in the process.

PayPal Payouts requires API access to be enabled in your PayPal account. Available for all business accounts.

Be sure to have balance in your PayPal account.

You will need to pay the PayPal transfer fees in order to payout your affiliates.

 

Note: This article relates to the PayPal Payouts pro add-on.

PayPal Payouts can process payments through PayPal’s MassPay API if your PayPal account has MassPay enabled. MassPay is an older PayPal technology that is not available to all accounts. If MassPay is not available to you, please use an API Application.

Connecting Your PayPal Account
Once PayPal Payouts is installed and activated, just like any other plugin, go to Affiliates → Settings → PayPal Payouts and enter your API keys. The API keys can be found in your PayPal account by going to Profile → My Selling Tools → API Access. From this screen you can request API credentials, if you don’t have them already, or view your existing API credentials:

Copy these API keys and enter them in your Arabianaffiliates settings, under Affiliates → Settings → PayPal Payouts.

As soon as your PayPal API keys are entered, you will be able to pay your affiliates their commissions instantly.

Note: This article relates to the PayPal Payouts pro add-on.

When processing payouts with PayPal, Arabianaffiliates will display an error message if something goes wrong. Error messages can be returned for a variety of reasons, such as insufficient account privileges, incorrect API credentials, or one of many other reasons.

If you are receiving an error when processing payouts, please use this guide as a reference for what the error means and how it can be resolved.

When an error is returned, it will be displayed like this:

Error: 403 Forbidden

This error means one of two things:

1. Your live API credentials have been entered incorrectly.

2. Your PayPal account has not been fully approved to process payouts via the API.

If you have confirmed that your API credentials are entered correctly, you will need to contact PayPal support and ask them to tell you why your account is unable to process payouts.

Error: 422 Unprocessable Entity

This error means one of two things:

The funding source for your PayPal account (where the funds are coming from) is inadequate, perhaps due to insufficient funds.
The currency code the funds are being sent in cannot be received by the recipient due to country or account regulations.
Error: 429 Too Many Requests

This error can occur when PayPal’s systems are under abnormal load. If this occurs, wait 30 minutes and then try again.

Error: 10001 Security Header Not Valid

This error is usually caused by one of two things:

1. The credentials entered at Affiliates → Settings → PayPal Payouts are incorrect. Please triple check you have entered them correctly.

2. You have entered the API certificate instead of an API Signature. Please check that you have entered the correct one.

Error: invalid_client Client Authentication failed

This error means the API credentials have been entered incorrectly. Please confirm you have copied the credentials properly from your PayPal account.