Manage Your Apps

The purpose of a REST API app is to generate your OAuth 2.0 credentials for the sandbox and live environments.

Create sandbox and live apps

To generate OAuth 2.0 credentials for the sandbox and live environments:

  1. Log into Dashboard and type your PayPal personal or business account email and password.
  2. In the REST API apps section, click Create App. The purpose of this app is to generate your credentials.
  3. Type a name for your app and click Create App. The page shows your sandbox app information, which includes your credentials.

    Note: To show your live app information, toggle to Live.

  4. Copy and save the client ID and secret for your sandbox app.
  5. Review your app details and save your app.

Note: You must have a PayPal business account to accept PayPal payments.

Review and edit your app details

You can review your app details, including your app's client ID and secret credentials, when you create your app. To edit an app, navigate to the My Apps & Credentials page and click the app name.

To go live, select My Account to enable features for your PayPal account. Alternatively, go directly to the My Account page.

Tip: To review your app's call history, click Sandbox > API Calls or Live > API Calls. These dashboards show the transaction date, type, status, amount and other details.

Note: To show your live app information, toggle to Live.

API credentials

The OAuth 2.0 client ID and secret credentials for the sandbox and live environments. You exchange these credentials for an access token that authorizes your REST API calls. To make live transactions, you must upgrade to a PayPal business account. To protect your customers and you, secure your credentials.

Note: To rotate your app secret, click Show and Generate New Secret. After you generate an app secret, 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

The PayPal REST APIs use webhooks for event notification. Webhooks are HTTP callbacks that receive notification messages for events. To create a webhook, configure a webhook listener and subscribe it to events. A webhook listener is a server that listens at a specific URL for incoming HTTP POST notification messages that certain sandbox or live webhooks events trigger.

App settings

Define your application settings.

  • Return URL. The website page to which you redirect buyers from the PayPal website. The test return URL can be different from the live return URL.

  • App feature options. Enable or disable app features.

    • Accept payments. Accept one-time and subscription payments from PayPal account holders. To configure this option, click Advanced Options. For a live app to accept PayPal payments, you must have a PayPal business account. Also, live apps can accept PayPal payments in only certain countries.

    • Invoicing. Issue invoices for and manage balances and enable custom net payment terms.

    • Payouts. Send batch payments to multiple PayPal accounts at once. You can vary the amount by recipient and deliver payments by phone number or email.

    • Customer Disputes. Use the Customer Disputes API to list disputes, provide evidence for a dispute, accept claims, show dispute details, and appeal disputes.

    • PayPal Here. Process swiped/card-present card transactions. To develop a custom PayPal Here app, use the PayPal Here SDKs.

    • Connect with PayPal. Enable your customers to use their PayPal login.

      Notes:

      • Connect with PayPal is not available for Mobile SDK apps.

      • You can create an app that leverages this feature if you have a PayPal account in your country. However, some countries restrict payments with live REST API credentials. If you are a non-U.S. developer, see the FAQs.

      To enable Connect with PayPal, click Advanced Options and provide the information for the sandbox or live environment.

      Select scope attributes for OpenID connect (OAuth) protocol. You are requesting your customers to share this data with you.

      • Personal Profile. Full name and email.
      • Address. Street address, city, state, country, and postal code.
      • Account Information. Account verification status and PayPal account ID (payer ID).
      • Links shown on customer consent page. Privacy policy URL and user agreement URL.
      • Additional PayPal permissions. Enable customers who have not yet confirmed their email with PayPal to log in to your app.
      Note: In the live environment, send your live app and its information to help-loginappreview@paypal.com to have customers share data in addition to their full name with you. Include the app's client ID, description, how your app uses Connect with PayPal, list of scope attributes to enable, and how the app uses each scope attribute. Approval is delayed until PayPal receives all information. The app review process typically takes from seven to ten days.
    • Transaction Search. Access your PayPal transaction history.

Additional information

Dashboards:

Feedback