How do I set up the PayPal REST integration?
Overview
PayPal's REST integration provides a fast and convenient method to make payments from Ambassador.
Please Note: If the information or links in this article appear outdated, below are a few alternative PayPal resources to try. If these also prove unsuccessful, please contact PayPal support through your business account. We try our best to provide accurate information and support, however PayPal regularly makes changes to their website, requirements, and processes.
- This PayPal Business support article
- This PayPal Developer article
- Visit the PayPal Business Help Center and search for "PayPal Rest API"
Important Notes
- PayPal Business account:
- Ensure you have a PayPal Business account with a confirmed email address and bank account.
- If you don't have one, you can sign up for a PayPal Business account on the PayPal website here.
- PayPal Payouts feature:
- Your PayPal Business account will need to have "Payouts" enabled. Not all PayPal accounts have this feature enabled automatically, especially if you are outside of the United States. We've provided information below on how to request permission to have this enabled, however if there's any question or these steps have changed, we recommend contacting PayPal support through your business account. It can take a few hours or up-to a few days to be approved.
- Sufficient Funds: PayPal Payouts are funded using your PayPal available balance, so ensure sufficient funds are available to cover the total payout amount and fees prior to processing a payout in Ambassador.
- Funding & Payout Limits:
- Be aware that PayPal has country specific-restrictions and limits for funding and payouts.
- PayPal FAQ.
- PayPal Country and Feature Support
- PayPal Payout Fees - Note: Within the rates table, pay attention to the column labeled "US – When using the Payouts API Fee"
- Be aware that PayPal has country specific-restrictions and limits for funding and payouts.
- PayPal Payouts Rest API: Ambassador integrates with your PayPal Business account using API credentials (a client ID and and client secret) to authenticate API calls made each time you process a payout. As you navigate through the process, it's important to keep the client secret safe (like a password).
Setup
Follow the steps below to get approval from PayPal to use the PayPal Payouts feature and configure your PayPal integration with Ambassador using the Rest API.
Step 1: Confirm that you have a PayPal Business account with access to it. If you do not have a PayPal business account, you can sign up here.
Important: You will also need to connect a bank account with your PayPal Business account to regularly add enough money to cover your reward payouts and fees. See "Important Notes" above.
Step 2: Request access to PayPal Payouts
- Log in to the PayPal Developer Portal here using the same credentials you use for your PayPal Business account.
- Click on your name and click "My account"
- Enable Payouts: Scroll down to the "Permissions" section and select the box for "Payouts". This will start the review process for enabling the Payouts feature for your account. You can also request access through your PayPal Customer Support.
- Note: PayPal will take between a few hours to several business days to approve your request. Once the Payouts API is enabled, please proceed from here.
Step 3: Obtain your live credentials
- Log into the Developer Dashboard with your merchant account.
- On the My Apps & Credentials page, change to Live.
- Click Create App in the REST API apps section.
- Type a name for your app and click Create App.
- Make a note of your LIVE REST API client ID and secret, and scroll down on the page to make sure Payouts is selected.
Step 4: Within Ambassador, enable PayPal and add your credentials
- Log into Ambassador and go to Settings > Payments > hover over PayPal with your mouse and click Configure.
- Paste in your (LIVE) Client ID and Client Secret, then click Save Integration.
Step 5: Ensure you have funds available and payout a reward for $1 to test with.
Note: Click here to review PayPal Payout Errors.
- The most common reasons for payout errors are:
You have not been approved by PayPal to issue payouts.- You added Sandbox credentials to Ambassador instead of Live credentials
- You do not have sufficient funds in your PayPal account to cover the amount and fee.
If you have any questions or run into issues related to PayPal, our support team will try our best to help but we recommend reaching out to PayPal support first.