NVP and SOAP API Reference

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

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

Express Checkout operations

• BAUpdate NVP, SOAP
• BillOutstandingAmount NVP, SOAP
• Callback NVP
• CreateBillingAgreement NVP, SOAP
• CreateRecurringPaymentsProfile NVP, SOAP
• DoAuthorization NVP, SOAP
• DoCapture NVP, SOAP
• DoExpressCheckoutPayment NVP, SOAP
• DoReauthorization NVP, SOAP
• DoReferenceTransaction NVP, SOAP
• DoVoid NVP, SOAP
• GetBalance NVP, SOAP
• GetBillingAgreementCustomerDetails NVP, SOAP
• GetExpressCheckoutDetails NVP, SOAP
• GetPalDetails NVP, SOAP
• GetRecurringPaymentsProfileDetails NVP, SOAP
• GetTransactionDetails NVP, SOAP
• ManageRecurringPaymentsProfileStatus NVP, SOAP
• RefundTransaction NVP, SOAP
• SetCustomerBillingAgreement NVP, SOAP
• SetExpressCheckout NVP, SOAP
• TransactionSearch NVP, SOAP
• UpdateAuthorization NVP, SOAP
• UpdateRecurringPaymentsProfile NVP, SOAP

Express Checkout operations by feature

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.

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:

• Payflow Basic Transaction Parameters
• Payflow Credit Card Transaction Parameters

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

Payflow Gateway advanced parameters

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

Payflow Gateway additional features

Payflow also offers the following features:

• Fraud Protection Service
• Recurring Billing

Website Payments Pro

Important: Website Payments Pro is currently available in the UK only. PayPal continues to support merchants with existing integrations outside the UK. New integrations outside the UK must use PayPal Payments Pro, the replacement for Website Payments Pro.

Website Payments Pro endpoints

Website Payments Pro operations

• BillOutstandingAmount NVP, SOAP
• CreateRecurringPaymentsProfile NVP, SOAP
• DoCapture NVP, SOAP
• DoDirectPayment NVP, SOAP
• DoNonReferencedCredit NVP, SOAP
• DoReauthorization NVP, SOAP
• DoReferenceTransaction NVP, SOAP
• DoVoid NVP, SOAP
• GetBalance NVP, SOAP
• GetRecurringPaymentsProfileDetails NVP, SOAP
• GetTransactionDetails NVP, SOAP
• ManagePendingTransactionStatus NVP, SOAP
• ManageRecurringPaymentsProfileStatus NVP, SOAP
• RefundTransaction NVP, SOAP
• TransactionSearch NVP, SOAP
• UpdateAuthorization NVP, SOAP
• UpdateRecurringPaymentsProfile NVP, SOAP

Website Payments Pro operations by feature

Website Payments Pro additional features

Website Payments Pro also offers:

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

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

Mass Payments operation

• 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.

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.

Adaptive Accounts operations

• AddBankAccount
  
• AddPaymentCard
  
• CheckComplianceStatus
  
• CreateAccount
  
• GetUserAgreement
  
• SetFundingSourceConfirmed
  
• UpdateComplianceStatus

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.

Invoicing operations

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

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.

Permissions Service operations

• CancelPermissions
• GetAccessToken
• GetAdvancedPersonalData
• GetBasicPersonalData
• GetPermissions* RequestPermissions

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.

Button Manager operations

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

Additional information

• API credentials
• PayPal Name-Value Pair API Basics
• PayPal SOAP API Basics
• PayPal Developer Documentation
• PayPal Credit^® (formerly Bill Me Later^®)
• API error codes
• User Parameter Data
• PayPal Manager