PayPal API Integration

PayPal API Integration

Suppose you have a PayPal account and you want all your customers’ payments from your company in OctopusPro to be received in your PayPal account. In that case, you need to integrate your OctopusPro account with your PayPal account, and you can do that with just a few steps.

Before connecting your OctopusPro account with your PayPal account, you need to start accepting PayPal with Braintree.

In order to start accepting PayPal with Braintree, you’ll need to:

Table of contents

Apply for a Braintree account

The first step is to apply for a Braintree account.

You can apply by calling their sales team directly at (877) 511-5036  or you can fill out the Braintree contact form.

Once you apply, a Braintree representative will help you finish the setup process to get you started and integrate with OctopusPro.

Or, you can Sign up for the sandbox and test it out first.

The Sandbox is a testing environment that allows you to get a feel for the Braintree experience before applying for a merchant account or going to production. Sandboxes are region specific, be sure to select the country your business is domiciled in when signing up.

The expected behavior in sandboxes can be simulated using sandbox testing values such as credit card numbers and transaction amounts. These testing values can be found on the Braintree Testing page. Actions taken in the sandbox do not result in actual funds being processed.

Your sandbox account is not linked to your production account in any way. Nothing created in the sandbox will transfer to production. This includes processing options and recurring billing settings. Your login information, merchant ID, and API keys will also differ.

How to Switch from Sandbox to Production

To go from Sandbox mode to live mode for Braintree, do the following:

In Dashboard, on the Application Links tab, click Settings and defaults under Firm.

  1. Select Practice > ePay.
  2. Click Setup.
  3. Click the Settings button for PayPal (Braintree).
  4. Clear the Sandbox account check box.
  5. Click OK to confirm.
  6. Click Submit.


You can get in touch with the Braintree sales team to take your integration live.

Once Braintree approves your application, you can now link your PayPal account. 

Enter the email for your PayPal account to accept payments through PayPal. If you haven’t set up PayPal in Braintree yet, follow these steps first:

Once you have confirmed that your merchant account is eligible to accept PayPal transactions, you must complete the following steps to add this payment method to your Braintree integration:

  • Sign up for a free, verified PayPal Business Account
  • Enter your PayPal credentials in the Braintree Control Panel
  • Add PayPal as a payment method using our PayPal guide in the developer docs

Sign up for a PayPal Business Account

In order to use PayPal with Braintree, you’ll need a PayPal Business Account. You can either sign up for a new account on PayPal’s website or upgrade an existing PayPal Premier account by completing the following steps:

  1. Go to the Settings page in your PayPal account
  2. Click Upgrade to a Business account
  3. Enter your business information and follow the remaining prompts

Verify your PayPal account

After setting up your new PayPal Business Account, you will need to verify specific personal information, such as your bank account details. 

Navigate to your profile in the PayPal console and follow the prompts to complete the verification process. If you are having trouble, contact PayPal support.

Enter your PayPal credentials in the Braintree Control Panel

You must enter your PayPal Business Account credentials in the Braintree Control Panel to enable this payment method in production. You can only link one PayPal account to your Braintree gateway. To complete your PayPal setup:

  1. Log into the Control Panel
  2. Click on the gear icon in the top right corner
  3. Click Processing from the drop-down menu
  4. Scroll to the Payment Methods section
  5. Next to PayPal, click the toggle to access the Accept PayPal options page
  6. Click the login with PayPal button
  7. Enter your PayPal login credentials and click login
  8. Enter the URLs to your website’s Privacy Policy and Terms and Conditions in the fields provided

Click the Submit button

(Note that: In order to accept PayPal, you must use Braintree Direct. If you are only using the Braintree gateway, your account is not eligible to accept PayPal. Contact Braintree for more information.)

Once you select Save, a processor overview page will appear. The Active status means the Braintree setup is complete.

Setup PayPal as API Integration in OctopusPro

After the setup is complete, you should now connect your OctopusPro account with your PayPal account. In order to link a PayPal account to any other software, you will need the API credentials for that PayPal account. To get the API credentials:

  1. Log in with your Braintree account.
  2. Select the cog on the top-right corner of the page
  3. Select API

Copy the Public Key, Private Key, and Merchant ID.

Then, log in to your OctopusPro account.

From your sidebar menu, go to Settings > Financial Settings > Payment Integration 

On the Payment Integration page, click on PayPal.

Fill in the required Braintree credentials you previously got from your Braintree account.

So, enter your Merchant ID, Public Key, and Private Key.

Click Save to integrate successfully.

For more information please visit Octopuspro user guide, and subscribe to our youtube channel.

Scroll to top