Get Started

Before you can integrate a PayPal product or solution, you must set up your development environment to get 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 test your web and mobile apps, you create sandbox accounts.

You must be in the PayPal Partner Program to make calls on behalf of a third party.

More information:

Get credentials

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.

Get an access token

To get an access token, pass your OAuth 2.0 credentials through either:

Make REST API calls

In REST API calls, include the URL to the API service for the environment:

  • Sandbox: https://api.sandbox.paypal.com
  • Live: https://api.paypal.com

Also, include your access token to prove your identity and access protected resources.

This sample call, which shows details for a web experience profile, includes a bearer token in the Authorization request header. This type of token lets you complete an action on behalf of a resource owner.

curl -v -X GET https://api.sandbox.paypal.com/v1/payment-experience/web-profiles/XP-8YTH-NNP3-WSVN-3C76 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer Access-Token"

The response shows the web experience profile details:

{
  "id": "XP-8YTH-NNP3-WSVN-3C76",
  "name": "exampleProfile",
  "temporary": false,
  "flow_config": {
    "landing_page_type": "billing",
    "bank_txn_pending_url": "https://example.com/flow_config/"
  },
  "input_fields": {
    "no_shipping": 1,
    "address_override": 1
  },
  "presentation": {
    "logo_image": "https://example.com/logo_image/"
  }
}

Create sandbox accounts

To test your web and mobile apps with mock transactions, create a personal account to represent the buyer and a business account to represent the merchant.

  1. Log into Dashboard and type your PayPal personal or business account email and password.

    Note: If you do not have an account, click Sign Up.

  2. Under Sandbox, click Accounts and click Create Account.
  3. To create the buyer account, select the personal account type. Type these required and any optional fields and click Create Account:
    • Email Address. A fake or valid email address. If you use a valid address, you receive email notifications when you run test transactions.
    • Password. An easy-to-remember password, such as 12345678.
    • PayPal Balance. A high amount, such as 5000.
  4. To create the merchant account, select the business account type, type account information, and click Create Account.

Feedback