NVP and SOAP API Reference

This reference details the endpoints and operations that are available for the PayPal SOAP and NVP (name-value pair) APIs.

The APIs and services are organized as follows:

• PayPal Payments
  Accept PayPal payments and credit card payments from a PayPal hosted checkout page.
  • Express Checkout
• Credit Card Payments
  Accept PayPal payments and credit card payments on a PayPal hosted or your own checkout page.
  • Payflow Gateway
    • PayPal Payments Pro and PayPal Payments Advanced
    • Payflow Pro and Payflow Link
  • Website Payments Pro (Legacy)
  • Website Payments Pro Hosted Solution (outside the US)
• Advanced Payment Solutions
  • Mass Payments
  • Adaptive Accounts
  • Invoicing
  • Permissions
• PayPal Payments Standard
  • Button Manager

For integration guides for these APIs and services, see NVP/SOAP API Development & Integration Guides.

Note: For Log In with PayPal, see Log In with PayPal buttons.

PayPal Payments

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

Express Checkout

Express Checkout is the most commonly used PayPal payments API, where payments are made on a PayPal hosted checkout page. Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API. See the API reference information below.

Express Checkout Endpoints

Express Checkout API Operations

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.

Payflow Gateway

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

The Payflow Gateway is a secure, open payment gateway supporting PayPal Payments Pro / Advanced and Payflow Pro / Link and is the preferred integration method for these products. You can choose to have PayPal host your payment pages or have total control over the payment process on your website.

With PayPal Payments Pro and Advanced, PayPal is your merchant bank, or with Payflow Pro and Link, you can use your existing merchant bank. Regardless which of these products you select, the Payflow Gateway allows you to accept debit and credit card payments. It also allows you to accept PayPal Express Checkout and PayPal Credit^® (formerly Bill Me Later^®) payments all within one API.

Payflow endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a call to the live environment or the pilot (test) environment. Be sure to pass the correct user credentials set in your account on https://manager.paypal.com/.

Payflow parameters

If you would like PayPal to host your payment pages, see Configuring Hosted Checkout Pages. For direct API calls, click on the following API reference links:

• Payflow Basic Transaction Parameters
• Payflow Credit Card Transaction Parameters

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

Advanced parameters

• Processors Requiring Additional Parameters
• Purchasing Card Level 2 and 3 Transaction Parameters
• TeleCheck Parameters

Additional features

Payflow also offers the following features:

• Fraud Protection Service
• Recurring Billing

Website Payments Pro

Note: Website Payments Pro is a legacy product and has been replaced by PayPal Payments Pro. Website Payments Pro is still supported for existing merchants. See the API reference information below.

Website Payments Pro endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Website Payments Pro API Operations

Additional features

Website Payments Pro also offers the following features:

• Fraud Management Filters
• Recurring Payments

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 website. The solution is available in Australia, France, Hong Kong, Italy, Japan, Spain, and the UK. See the integration guide for a particular country.

Advanced Payment Solutions

Mass Payments

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

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Mass Payments API Operation

Click these links to view the API reference documentation.

MassPay NVP, SOAP

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 and the API reference information below.

Adaptive Accounts endpoints

Include an AppID with your API credentials when making Adaptive Accounts API calls.
For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

Adaptive Accounts API Operations

Click these links to view the API reference documentation.

AddBankAccount
AddPaymentCard
CheckComplianceStatus
CreateAccount
GetUserAgreement
GetVerifiedStatus
SetFundingSourceConfirmed
UpdateComplianceStatus

Invoicing

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

Invoicing endpoints

Include an AppID with your API credentials when making API calls to the Invoicing service.

For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

Invoicing API Operations

Click these links to view the API reference documentation.

CancelInvoice
CreateAndSendInvoice
CreateInvoice
DeleteInvoice
GenerateInvoiceNumber
GetInvoiceDetails
MarkInvoiceAsPaid
MarkInvoiceAsRefunded
MarkInvoiceAsUnpaid
RemindInvoice
SearchInvoices
SendInvoice
UpdateInvoice

Permissions

The Permissions Service enables you to obtain permission to execute PayPal API operations on behalf of PayPal account holders. See the API reference information below.

Permissions endpoints

Include an AppID with your API credentials when making API calls to the Permissions service.

For Sandbox testing, use the following Sandbox AppID: APP-80W284485P519543T

Permissions API Operations

Click these links to view the API reference documentation.

CancelPermissions
GetAccessToken
GetAdvancedPersonalData
GetBasicPersonalData
GetPermissions
RequestPermissions

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 item(s) associated with the button. Adding a PayPal button to your website does not require advanced coding experience.

To modify your PayPal buttons directly using HTML code, refer to:

• PayPal Button HTML Variables reference
• PayPal button image reference

Button Manager

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

Button Manager endpoints

Send your API calls to one of the following endpoints, depending on whether you are making a Name-Value Pair (NVP) or SOAP call. Make sure you have the correct API credentials to use this API.

Button Manager API Operations

Click these links to view the API reference documentation.

BMButtonSearch — NVP, SOAP
BMCreateButton — NVP, SOAP
BMGetButtonDetails —NVP, SOAP
BMGetInventory — NVP, SOAP
BMManageButtonStatus — NVP, SOAP
BMSetInventory — NVP, SOAP
BMUpdateButton — NVP, SOAP

Additional information

• AddressVerify errors - 10004 to 10014
• Billing agreement errors - 10004 to 13200
• RefundTransaction errors
• DoNonReferencedCredit errors