Manage your applications
Learn how to create and manage REST API apps.
You can create REST API apps with one or more of these capabilities:
|Accept Payments||Accept PayPal and enable direct credit card processing.|
|Invoicing||Create, send, and manage your invoices. Get paid online with a credit card, a debit card, or PayPal.|
|Payouts||Send batch payments to multiple PayPal accounts at once.|
|PayPal Here||Process swipe/card-present card transactions.|
|Connect with PayPal
(formerly Log In with PayPal)
|Enable users to log in to your app with their PayPal account credentials.
You can click the app name on the My Apps & Credentials page to view or edit the app details, including the authorization protocol.
Note: You can create an app that can take advantage of the Connect with PayPal feature as long as you have a PayPal account in your country. However, accepting payments with live REST API credentials is restricted in some countries. If you are a non-U.S. developer, see the FAQs.
Create an app for testing
- From the My Apps & Credentials page, log in with your PayPal account.
- Under REST API apps, click Create App.
- Enter an App Name and click Create App. PayPal displays information about your app. You can review and modify the app details.
Note: In the top right-hand corner, you can toggle between sandbox and live app information.
- Click Save.
- Go live. Before you go live, you might need to upgrade your PayPal account.
Review information about your app
|API credentials||The sandbox or live account's client ID and secret credentials that you use for authorization when you make API calls. To test, use your sandbox credentials. To make live transactions, use your live credentials. With live transactions, you might need to upgrade from a personal to a business PayPal account. To protect your customers and you, secure your credentials.
Note: To rotate your app secret, click Show and then click Generate New Secret. After a new app secret is generated, you can disable the old secret and enable the new one. Do not disable your app secret if live API calls still use it.
|Webhooks||Your sandbox or live webhooks events. These notifications are sent to your server when specific events are triggered, such as when a payment status changes to pending.|
The sandbox or live app details provide an option to set one or more return URLs.
A return URL is your website page to which you redirect buyers from the PayPal website. The test return URL can be different from the live return URL.
You must specify all return URLs for an application in the Developer dashboard before you can use that return URL in an app. For example, if you develop a REST app and you configure Connect with PayPal, you must configure the return URL for the app in the Developer dashboard for it to work in you LIPP configuration.
Provide information for a Connect with PayPal app
For apps that support Connect with PayPal, click Advanced Options and provide the required information.
Important: Before going live, PayPal must review your app to approve the sharing of customer data. To send the app to review, follow the instructions on the My App & Credentials in the Developer Portal. The app review process takes 7-10 business days, typically.
Set the following options for both your sandbox and live app by using the toggle in the top right-hand corner of the page:
Note: All new apps use the Open ID Connect (OAuth2) protocol.
Information requested from customers—Select the PayPal user information details that you would like the user to share with you.
Note: After a user logs in to your app and consents to share data, Open ID attribute data is provided to your app. The following app details include a level of attribute data that customers can consent to share with your app. If necessary, you can customize that level.
Basic authentication Enabled by default. Provides a unique identifier for each customer. Personal information Collects name and age-related details. To select only the information that you require, click customize. Address information Collects email, mailing address, and phone information. To select only the information that you require, click customize. Account information Retrieves user profile attributes. You can use information such as
email_verified(Boolean) and account status
Note: If your app requires advanced attributes for OAuth 2.0 or OpenID Connect, make sure your Domain URL uses
Optionally, you can add a customer support email address or preview the customer consent page, which is the page the PayPal user sees before consenting to share information with your app.
Additional PayPal permissions
Enable customers who have yet to confirm their email address with PayPal to log in to your app By default, PayPal requires users to first confirm their account.
Review details and credentials
After you create the app, or when you navigate to the My Apps & Credentials page and click the app name, you can review the app details, including your app's client ID and secret credentials. You can also edit the app from this view.
If you are going live, select My Account to confirm that your desired features are enabled for your PayPal account. Alternatively, go directly to the My Account page.
Tip: To review the call histories for all your PayPal apps, use the Sandbox Transactions and Live Transactions dashboards, which provide the histories of API calls made by apps in each environment. The dashboards display details such as the date of the transaction, type of transaction, status, amount, as well as the details of the API call, such as the request and response messages. The dashboards enable you to view the call history for all apps or a specific app.
Upgrade your PayPal account
Before attempting to use a live app to directly accept credit cards, go to the My Account page. To use a live app to directly accept credit cards, you might need to sign up for PayPal Payments Pro, which is a paid subscription.
Note: You must have a PayPal Business account to accept PayPal as a payment method.
- Billing Plans and Agreements
- Identity overview
- Invoicing overview
- Connect with PayPal
- PayPal Here SDKs
- PayPal Payments Pro
- Test Payments