PayPal Plugin API Keys Configuration Guide

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 Payout plugin as well. 

The admin can configure the PayPal payment gateway from System Settings > Plugins > Regular Payment Methods > PayPal > Settings. 

Fig. 1.1: PayPal Settings at Admin-end

Key Components: 

  1. Create New App 
  2. Configure API keys and Payee Email 


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 

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

Fig. 4: ‘My Apps & Credentials’ Page 

  1. 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. 
  2. Then, the admin must click on the ‘Create App’ button to create an app in their PayPal account. 
  3. 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. 2.5: 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 Payout plugin as well. 

The ‘Sandbox Account’ needs to be copied and entered in the ‘Payee Email’ input field provided for PayPal plugin settings (figure 1). 

When copying the keys, please make sure that the same environments are selected on both sides (paypal account and admin panel).