NVP and SOAP API Reference

Learn about the PayPal Name-Value Pair (NVP) and SOAP API endpoints and operations.

Payment type Products
PayPal payments

Accept PayPal and credit card payments on your website from a PayPal-hosted checkout page.

Credit card payments

Host your own checkout pages or use PayPal-hosted checkout pages for accepting credit and other payment card transactions on your website, in addition to PayPal payments.

Advanced Payment Solutions
PayPal Payments Standard

If you have a PayPal Business or Premier account, you can use the PayPal Button Creation Tool to create the HTML code needed to place a PayPal button on your website. The generated HTML code, when pasted into one of your website pages, displays a PayPal button that lets customers use their PayPal account to purchase the items associated with the button. Adding a PayPal button to your website does not require advanced coding experience.

Log In with PayPal Log In with PayPal buttons

Express Checkout

Express Checkout is the most commonly used PayPal payments API. Payments are made on a PayPal-hosted checkout page.

The endpoint to which you send your API calls depends on whether you are making an NVP or SOAP call. To use this API, make sure you have the correct API credentials.

Important: This integration method is Deprecated as of January 1, 2017. For new integrations, see the PayPal Express Checkout Integration Guide.

Express Checkout endpoints

Authentication Format Endpoints
API certificate NVP Live https://api.paypal.com/nvp
Sandbox https://api.sandbox.paypal.com/nvp
SOAP Live https://api.paypal.com/2.0/
Sandbox https://api.sandbox.paypal.com/2.0/
API signature NVP Live https://api-3t.paypal.com/nvp
Sandbox https://api-3t.sandbox.paypal.com/nvp
SOAP Live https://api-3t.paypal.com/2.0/
Sandbox https://api-3t.sandbox.paypal.com/2.0/

Express Checkout operations

Express Checkout operations by feature

Feature Operations
Express Checkout
Authorization and capture
Recurring payments / reference transactions
  • BAUpdate NVP, SOAP
  • BillOutstandingAmount NVP, SOAP
  • CreateBillingAgreement NVP, SOAP
  • CreateRecurringPaymentsProfile NVP, SOAP
  • DoReferenceTransaction NVP, SOAP
  • GetBillingAgreementCustomerDetails NVP, SOAP
    (Deprecated after version 54.0)
  • GetRecurringPaymentsProfileDetails NVP, SOAP
  • ManageRecurringPaymentsProfileStatus NVP, SOAP
  • SetCustomerBillingAgreement NVP, SOAP
    (Deprecated after version 54.0)
  • UpdateRecurringPaymentsProfile NVP, SOAP
Refunds
Inventory management
PayPal accounts

Payflow Gateway

The Payflow Gateway is a secure, open payment gateway that supports and is the preferred integration method for these products:

  • PayPal Payments Pro
    PayPal Payments Advanced
    PayPal is the acquirer and merchant bank.
  • Payflow Pro
    Payflow Link
    You choose your own processing platform and merchant bank.

You can choose to have PayPal host your payment pages or have total control over the payment process on your website.

No matter which product you select, the Payflow Gateway enables you to accept debit and credit card payments, and PayPal Express Checkout and PayPal Credit® (formerly Bill Me Later®) payments all within one API.

Payflow Gateway endpoints

The endpoint to which you send your API calls depends on whether you are making a live or test call. All Gateway transactions require the user data parameters, which you set in your account on PayPal Manager.

Format Endpoints
NVP Live https://payflowpro.paypal.com
Sandbox https://pilot-payflowpro.paypal.com

Payflow Gateway parameters

To have PayPal host your payment pages, see Configuring Hosted Checkout Pages. For direct API calls, click on the following API reference links:

Note: For Transparent Redirect information, see PCI Compliance Without Hosted Pages.

Payflow Gateway advanced parameters

Payflow Gateway additional features

Payflow also offers the following features:

Website Payments Pro

Website Payments Pro endpoints

Authentication Format Endpoints
API certificate NVP Live https://api.paypal.com/nvp
Sandbox https://api.sandbox.paypal.com/nvp
SOAP Live https://api.paypal.com/2.0/
Sandbox https://api.sandbox.paypal.com/2.0/
API signature NVP Live https://api-3t.paypal.com/nvp
Sandbox https://api-3t.sandbox.paypal.com/nvp
SOAP Live https://api-3t.paypal.com/2.0/
Sandbox https://api-3t.sandbox.paypal.com/2.0/

Website Payments Pro operations

Website Payments Pro operations by feature

Feature Operations
Direct credit card payment
  • DoDirectPayment NVP, SOAP

    Use this API operation for sale or authorization transactions on a payment card.

Authorization and capture
Recurring payments /
reference transactions
  • BillOutstandingAmount NVP, SOAP
  • CreateRecurringPaymentsProfile NVP, SOAP
  • DoReferenceTransaction NVP, SOAP
  • GetRecurringPaymentsProfileDetails NVP, SOAP
  • ManageRecurringPaymentsProfileStatus NVP, SOAP
  • UpdateRecurringPaymentsProfile NVP, SOAP
Refunds
Fraud management filters
  • ManagePendingTransactionStatus NVP, SOAP
Transaction management
PayPal accounts

Website Payments Pro additional features

Website Payments Pro also offers:

Website Payments Pro hosted solution (outside the US)

This product is for merchants and developers that want to integrate with PayPal's hosted solution to add transaction processing to their websites. The solution is available in Australia, France, Hong Kong, Italy, Japan, Spain, and the UK. See the integration guide for your country.

Country Local product name - language
Australia Website Payments Pro Hosted Solution - AU English
France PayPal Intégral Evolution - FR English
PayPal Intégral Evolution - FR French
Hong Kong Website Payments Pro Hosted Solution - HK English
Italy PayPal Pro - IT English
PayPal Pro - IT Italian
Japan Website Payments Plus - JP English
Website Payments Plus - JP Japanese
Singapore Website Payments Pro Hosted Solution - SG English
Spain Pasarela Integral - ES English
Pasarela Integral - ES Spanish
United Kingdom Website Payments Pro Hosted Solution - UK English

Mass Payments

Note: The MassPay API is Deprecated as of September 1, 2017. For new integrations, see the Payouts Overview.

Merchants use Mass Payments to send money instantly to up to 250 recipients at once. To send payments to multiple recipients, merchants only need the recipient's PayPal account email address, the payment amount, and the currency code. Merchants can manually upload a file listing payments or create them programmatically by using the MassPay API. To send mass payments manually, see Using Mass Payments in your PayPal Account.

Mass Payments endpoints

The endpoint to which you send your API calls depends on whether you are making an NVP or SOAP call. To use this API, make sure you have the correct API credentials.

Important: This integration method is Deprecated as of January 1, 2017. For new integrations, see the PayPal Express Checkout Integration Guide.

Authentication Format Endpoints
API certificate NVP Live https://api.paypal.com/nvp
Sandbox https://api.sandbox.paypal.com/nvp
SOAP Live https://api.paypal.com/2.0/
Sandbox https://api.sandbox.paypal.com/2.0/
API signature NVP Live https://api-3t.paypal.com/nvp
Sandbox https://api-3t.sandbox.paypal.com/nvp
SOAP Live https://api-3t.paypal.com/2.0/
Sandbox https://api-3t.sandbox.paypal.com/2.0/

Mass Payments operation

Adaptive Accounts

The Adaptive Accounts API allows you to create and manage PayPal accounts for PayPal users. To make an API call, see Adaptive Accounts API call headers and endpoints.

Adaptive Accounts endpoints

To make Adaptive Accounts API calls. include an AppID with your API credentials.

For sandbox testing, specify an AppID of APP-80W284485P519543T.

API Formats Endpoints
Adaptive Accounts SOAP with XML,
NVP, or JSON
Live https://svcs.paypal.com/AdaptiveAccounts/
Sandbox https://svcs.sandbox.paypal.com/AdaptiveAccounts/

Adaptive Accounts operations

Invoicing

You can use the Invoicing Service API to create, send, and manage invoices using PayPal.

Invoicing endpoints

To make API calls to the Invoicing service, include an AppID with your API credentials.

For sandbox testing, specify an AppID of APP-80W284485P519543T.

API Formats Live and sandbox endpoints
Invoicing Service SOAP with XML,
NVP, or JSON
https://svcs.paypal.com/Invoice/API-Operation
https://svcs.sandbox.paypal.com/Invoice/API-Operation

Invoicing operations

Permissions Service

The Permissions Service enables you to obtain permission to execute PayPal API operations on behalf of PayPal account holders.

Permissions Service endpoints

To make API calls to the Permissions Service, include an AppID with your API credentials.

For sandbox testing, specify an AppID of APP-80W284485P519543T.

Formats Endpoints
SOAP with XML, NVP, or JSON Live https://svcs.paypal.com/Permissions/API-Operation
Sandbox https://svcs.sandbox.paypal.com/Permissions/API-Operation

Permissions Service operations

Button Manager

For more advanced PayPal button manipulation, use the ButtonManager API.

To modify your PayPal buttons directly using HTML code, see PayPal Button HTML Variables reference.

Button Manager endpoints

Send your API calls to one of the following endpoints, depending on whether you are making an NVP or SOAP call. Make sure you have the correct API credentials to use this API.

Authentication Format Endpoints
API certificate NVP Live https://api.paypal.com/nvp
Sandbox https://api.sandbox.paypal.com/nvp
SOAP Live https://api.paypal.com/2.0/
Sandbox https://api.sandbox.paypal.com/2.0/
API signature NVP Live https://api-3t.paypal.com/nvp
Sandbox https://api-3t.sandbox.paypal.com/nvp
SOAP Live https://api-3t.paypal.com/2.0/
Sandbox https://api-3t.sandbox.paypal.com/2.0/

Button Manager operations

Additional information