API Basics

PayPal offers both RESTful and Classic (SOAP/NVP) interfaces to help you create a payments solution that meets your specific needs. The provided interfaces enable you to incorporate PayPal functionality into your website applications and mobile apps.

PayPal's REST API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON. For more information, see REST API Reference.

The NVP/SOAP APIs support calls made using both SOAP and non-SOAP formats. In addition, call payloads can be formatted in JSON and NVP. For detailed information about API credentials, required HTTP headers, and more, see PayPal NVP/SOAP APIs Getting Started Guide.

Developer Process

To develop applications that take advantage of PayPal interfaces, follow these steps:

  1. Register as a PayPal Developer.

    If you haven't already registered, you can do so by selecting the Sign Up button on the PayPal Developer site.

  2. Learn how to make PayPal API calls.

    For REST APIs, see Make your first call.

    For NVP/SOAP APIs, see PayPal NVP/SOAP APIs Getting Started Guide.

  3. Prepare to test in the Sandbox.

    For REST APIs, see Create an app for testing.

    For NVP/SOAP APIs, see Creating Sandbox test accounts.

  4. Use the correct endpoints and credentials.

    For REST APIs, see each operation in the REST API Reference for endpoint information and Authentication & Headers for credentials.

    For NVP/SOAP APIs, see NVP/SOAP API Endpoints and Creating and Managing NVP/SOAP API Credentials.

  5. Refer to integration documentation for guidance.

    For REST APIs, see the overview for the operations you want to use: Payments, Vault, Identity, Invoicing, Payment Experience, Notifications

    For NVP/SOAP APIs, select the information you need from the list of Development & Integration Guides.

  6. Test your application in the Sandbox.

    For REST APIs, see Manage your applications.

    For NVP/SOAP APIs, see the PayPal Sandbox testing guide.

  7. Go live with your application.

    For REST APIs, see Manage your applications.

    For NVP/SOAP APIs, see Going Live with Your Application.

Support, documentation, and other resources

Reference and other resources are available at the following locations:

scroll to top