Please check ‘Activate Live Payment Transaction Mode’ settings provided in System Settings > General Settings > Checkout tab before switching to sandbox/production modes. 

Please note that the same ‘Client id’ and ‘Client Secret’ keys can be also used for the Paypal plugin as well. 

The PayPal Payout keys can be configured by the admin from System Settings > Plugins > Payout > PayPal Payout > Settings. 

Fig. 1: PayPal Payout Settings at Admin-end

Key Components: 

1. Create New App 
2. Configure API keys 
3. Add Return URL and Webhooks

Create New App

Please skip this step if you already have an existing app. To create a new app- 

1. Visit https://developer.paypal.com/home/ and click on the ‘Login to Dashboard’ button provided at the top-right corner as shown in figure 2. 

Fig. 2: PayPal Login/Sign Up Page

The admin must login by entering their credentials in the ‘PayPal Login’ form (refer figure 3). If not a registered user, the admin must Sign up by clicking on the ‘Sign Up’ button. 

Fig. 3: PayPal Login Form 

2. Once logged in, the admin will be redirected to ‘My apps & Credentials’ page as shown in figure 4. 

Fig. 4: ‘My Apps & Credentials’ Page 

3. The admin must select if they wish to proceed with creating ‘Sandbox’ (Developer Mode) or ‘Live’ credentials from the button provided on the top of this page as shown in figure 4. 
   This guide will proceed further with creating ‘Sandbox’ credentials and the steps for creating credentials for any of them is the same. 
4. Then, the admin must click on the ‘Create App’ button to create an app in their PayPal account. 
5. The admin must enter the ‘App Name’ and ‘Sandbox Business Account’ and then click on the ‘Create App’ button to finish creating the app. 

Fig. 5: Create New App 

Configure API keys and Payee Email 

Once the app is created, the admin will be redirected to the page that displays the created app along with the ‘Sandbox Credentials’. 

As shown in figure 6, this page displays the ‘Sandbox Account’, ‘Client Id*’ and ‘Secret*’ keys. Please use the ‘Show’ button to have access to the secret key. 

Fig. 6: Sandbox Credentials Page for Created App

Please copy the ‘Client id’ and ‘Client Secret’ keys and paste them in the respective input fields provided in the admin plugin settings (figure 1). 

Please note that the same ‘Client id’ and ‘Client Secret’ keys can be also used for the Paypal plugin as well. 

Add Return URL and Webhooks

To complete the configuration process for PayPal Payout please follow the steps ahead. 

Scrolling down on this page, there is a ‘Sandbox App Settings’ section in which the admin can mention the return URL by clicking on the ‘Show’ button provided in the ‘Return URL’ section as shown in figure 7. 

Fig. 7: Sandbox App Settings

Clicking on the ‘Show’ button will open a new section as shown in figure 8. 

Fig. 8: Return URL Section

The format to be followed to enter the URL is: <DOMAIN>/pay-pal-payout/callback. 

Admin can mention the Return URL(s) and then click on the ‘Save’ button provided in the bottom of this section. 

Scrolling to the bottom of this page, there is a ‘Sandbox Webhooks’ section as shown in the figure 9 below.

Fig. 9: Sandbox Webhooks Section

Please click on the ‘Add Webhook’ button to add a new webhook. 

A new section will open in which the admin must enter the ‘Webhook URL’ in the input field provided as shown in figure 10. 

The format to be followed to enter the URL is: <DOMAIN>/pay-pal-payout/callback. 

The next step is to select events from the ‘Event Types’ section as shown in figure 10. 

Fig. 10: Add a Webhook

Either the admin can select ‘All Events’ option provided at the top of the list or they can select the following important options - 

• PAYMENT PAYOUTS-ITEM SUCCEEDED
• PAYMENT PAYOUTS-ITEM CANCELED
• PAYMENT PAYOUTS-ITEM DENIED
• PAYMENT PAYOUTS-ITEM FAILED
• PAYMENT PAYOUTS-ITEM UNCLAIMED

Please make sure that the changes are updated by clicking on the ‘Save’ button provided at the end of this section.