NVP/SOAP API Development & Integration Guides

The following list links to the integration guides for the PayPal NVP/SOAP APIs. These integration guides do not include v.zero SDK and PayPal REST API integration details. For information on PayPal's more recently introduced API products, see all PayPal API docs.

Alphabetical List of APIs and Tools

Note: To view documentation for previous versions of PayPal products, see the Documentation Archive.


Adaptive Accounts

Get Started

Adaptive Accounts Integration Guide
The Adaptive Accounts API lets you build applications that create PayPal accounts and handle account management.

Adaptive Payments

Get Started

Adaptive Payments Integration Guide
The Adaptive Payments API enables you to send money in many different scenarios, from simple to complex. For example, you might use it for marketplaces, build a small send money application for a social networking site or a robust payroll system.

Express Checkout

Get Started

Integration Overview

Express Checkout Basic and Advanced Features Integration Guide
Learn the basics of how to integrate Express Checkout with your website. Also learn about advanced features that enhance your integration of Express Checkout, such as customizing PayPal payment pages to match the look of your website and updating shipping charges as buyers make changes on the PayPal review page.

Express Checkout Advanced Features Integration Guide (Japanese)

In-Context Checkout in Express Checkout (New)
In-Context Checkout speeds buyers through payments in as few as 1 or 2 clicks — without leaving your website — for a secure, simplified and seamless checkout. Learn the quick integration steps for in-context checkout.

Digital Goods in Express Checkout Integration Guide
Learn how to streamline the checkout process for buyers of digital goods. Buyers can conveniently purchase digital goods during checkout with a minimum of clicks without leaving your website or interrupting their online activities.

Preparing for the PayPal Checkout Experience
Learn about the PayPal Checkout experience for Express Checkout. This guide provides the programming variables to customize the checkout user interface.

Name-Value Pair API Developer Guide and Reference 
Learn how to use the Express Checkout Name-Value Pair API. Includes an API reference and information on SDKs with code samples for the SDKs.

SOAP API Developer Guide and Reference
Programmers familiar with SOAP (Simple Object Access Protocol) can learn more about the Express Checkout SOAP API. Includes an API reference and information on SDKs with code samples for the SDKs.

Sandbox User Guide
Learn how to test your PayPal-based application before it goes live with the Sandbox, PayPal's virtual test environment.

Express Checkout User Interface Standards
This guide lists the requirements and best practices for placing PayPal graphic images on your website. It also explains how buyers experience PayPal checkout on your website, and how you can modify that buyer experience depending on your needs.

Fraud Protection Services/Fraud Management Filters

Please select your documentation based on the product below:

Fraud Protection Services for PayPal Payments Pro (Payflow) Fraud Management Filters for Website Payments Pro
Payflow Fraud Protection Services User's Guide
How to integrate the Fraud Protection Services into your Payflow solution.
Fraud Management Filters
How to use Fraud Management filters in your Website Payments Pro solution.

Invoicing Service

Get Started

Invoicing Service Integration Guide
You can use the Invoicing Service API to programmatically create, send, and manage invoices using PayPal. View Invoicing Service API examples, along with information on API references.

Mass Payments

Get Started

Mass Payments Integration Guide
Learn how to use Mass Payments to send multiple payments in one batch.

Merchant Setup and Administration Guide

Merchant Setup and Administration Guide
Learn how merchants set up and administer their accounts, including setting their credit card statement names, blocking certain kinds of payment, adding users to their accounts, managing multiple currency balances, creating custom payment pages, and getting contact numbers from payers.

Payflow Gateway / PayPal Payments Pro

Get Started

Get Started with Hosted Pages

Payflow Gateway / PayPal Payments Pro Developer Guide and Reference
Payflow Gateway is PayPal's secure and open payment gateway. Using the Payflow Gateway APIs, merchants can process debit and credit card payments, PayPal, PayPal Credit®, authorizations, captures, and credit voids.

Express Checkout for Payflow
How to integrate Express Checkout for Payflow Gateway.

Payflow XMLPay Developer Guide
How to use XMLPay for payment transaction requests and responses. Use in conjunction with the Payflow Gateway Developer's Guide.

Payflow Gateway Reporting Developer Guide
Learn about the XML API, which enables you to develop Web and desktop applications that create, schedule, and run standard (pre-defined) and custom Payflow services reports.

PayPal Processor Setup Guide
A list of compatible processors for Payflow and the fields required to enable transactions for each processor.

Payflow Fraud Protection Services User's Guide
How to integrate the Fraud Protection Services into your Payflow Gateway solution.

Payflow Recurring Billing User's Guide
How to integrate the Recurring Billing service into your Payflow Gateway solution.

Payflow ACH Payment Service Guide
How to implement Automated Clearinghouse (ACH) bank account payments with Payflow Gateway.

Moneris Receipts Specification
How to implement the Moneris processor Receipt requirements for the Card Payment Interface system. It covers requirements and recommendations for creating credit transaction receipts for customer and Merchant copies.

XMLRegister XML Syntax Reference Guide
For PayPal Partner use only.

PayPal Mobile

Are you building a mobile website? PayPal's mobile solutions provide payment functionality to your apps allowing users to pay via a PayPal account or credit card. Whether you want a user to stay in app or use a browser, PayPal offers several choices for ensuring fast, secure and easy payments on Android and iOS platforms, or your mobile website.

PayPal Mobile SDKs

The PayPal iOS SDK and PayPal Android SDK provide native libraries that simplify accepting credit card and PayPal payments in your mobile apps. The libraries present a simple UI, features card.io credit card scanning, and uses a proof-of-payment system that can ease the burden of PCI compliance.

Mobile PayPal Payments Standard (MPPS)

For a simple HTML based integration, you can integrate with Mobile PayPal Payments Standard. If you are already a PayPal Payments Standard customer you may already be done.

Mobile Express Checkout (MEC)

If you have a mobile website, you can integrate our Mobile Express Checkout (MEC) APIs to redirect the buyer to the PayPal mobile-optimized Express Checkout experience. This leverages the same Express Checkout APIs that are used for online integrations. If you've integrated Express Checkout online, you may already be done.

Get Started

Express Checkout on Mobile Devices

PayPal Payments Advanced (US & Canada only)

Get Started

Payflow Gateway Developer Guide and Reference
PayPal Payments Advanced enables you to use PayPal hosted checkout pages with or without the Payflow Gateway SDK to integrate a Payflow Gateway payments solution into your website or application.

Embedded Checkout Design Guide

Configuring PayPal Payments Advanced for Partners

Payflow Gateway Reporting Developer Guide
Learn about the XML API which enables you to develop Web and desktop applications that create, schedule, and run standard (pre-defined) and custom Payflow services reports.

PayPal Payments Standard (PayPal Payment buttons)

Get Started

PayPal Payments Standard Integration Guide
Learn how to use HTML forms and get paid through PayPal.

Preparing for the New Updated PayPal Checkout Experience
Learn about the new updated PayPal Checkout experience for PayPal Payments Standard. This guide provides the programming variables to customize the new updated checkout user interface.

Note: For PayPal Payments Standard, the new updated experience applies only to Buy Now and Add to Cart buttons and the Cart Upload command.

Sandbox User Guide
Learn how to test your PayPal-based application before it goes live with the Sandbox, PayPal's virtual test environment.

Name-Value Pair (NVP) Button Manager API
This document is intended for merchants who would like to programmatically auto-generate PayPal payment buttons using a name-value pair API.

SOAP Button Manager API
This document is intended for merchants who would like to programmatically auto-generate PayPal payment buttons using a SOAP API.

Merchant Gift Certificates Guide
Learn how to add Merchant Gift Certificates to your site. Merchant Gift Certificates allow you to easily create, publish, and sell customized gift certificates.

Permissions Service

Get Started

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

Recurring Billing/Recurring Payments

PayPal Recurring Billing/Recurring Payments allows merchants to bill a buyer for a fixed amount of money on a fixed schedule.

Please select your documentation based on a product below:

Reporting

PayPal Reports
For a comprehensive list of merchant reports and reporting guides, see the Reporting page.

Order Management and Notifications

How To Search for Transaction Data using the Merchant API
Learn how to use the TransactionSearch and GetTransactionDetails API operations of the Express Checkout / Direct Payment APIs to look up transaction information.

Instant Payment Notification (IPN) Guide
Instant Payment Notification (IPN) is a message service that notifies you of events related to PayPal transactions. You can use IPN to automate back-office and administrative functions.

Payment Data Transfer (PDT) integration information
PayPal's Payment Data Transfer (PDT) system sends order confirmations to merchant sites and lets them authenticate this information. Learn more about the differences between IPN and PDT in this section of the IPN integration guide.

Website Payments Pro

Website Payments Pro enables merchants and developers to accept credit cards, debit cards, and PayPal payments directly on their website. Website Payments Pro also includes Express Checkout and Virtual Terminal. Add-on services like Fraud Management Filters and Recurring Billing are also available.

Website Payments Pro Integration Guide
Learn how your website can enable customers to check out using PayPal Direct Payment or PayPal Express Checkout as payment solutions.

Express Checkout Basic and Advanced Features Integration Guide
Learn the basics of how to integrate Express Checkout with your website. Also learn about advanced features that enhance your integration of Express Checkout, such as customizing PayPal payment pages to match the look of your website and updating shipping charges as buyers make changes on the PayPal review page.

Express Checkout Advanced Features Guide (Japanese)

Name-Value Pair API Developer Guide and Reference 
Learn how to use the Express Checkout Name-Value Pair API. Includes an API reference and information on SDKs with code samples for the SDKs.

SOAP API Developer Guide and Reference
Developers familiar with SOAP (Simple Object Access Protocol) can learn more about the Express Checkout SOAP API. Includes an API reference and information on SDKs with code samples for the SDKs.

Recurring Payments
Learn how to use Recurring Payments for Website Payments Pro.

Fraud Management Filters
Learn how to use Fraud Management filters with your Website Payments Pro solution.

Sandbox User Guide
Learn how to test your PayPal-based application before it goes live with the Sandbox, PayPal's virtual test environment.

Website Payments Pro Hosted Solution (Outside the US)

Website Payments Pro Hosted Solution Integration Guide
This guide is for merchants and developers who want to integrate with PayPal's Hosted Solution to add transaction processing to their website. The solution is built on the Pro 3.0 stack and available in Australia, France, Hong Kong, Italy, Japan, Spain, and the UK.

Country Local Product Name Language of Integration Guide
Australia Website Payments Pro Hosted Solution English
France PayPal Intégral Evolution English, French
Hong Kong Website Payments Pro Hosted Solution English
Italy PayPal Pro English, Italian
Japan Website Payments Plus English, Japanese
Singapore Website Payments Pro Hosted Solution English
Spain Pasarela Integral English, Spanish
United Kingdom Website Payments Pro Hosted Solution English

Website Payments Pro Hosted Solution Integration Guide, Payflow Edition (UK)
This guide is for Website Payments Pro Payflow Edition (UK) merchants and developers who want to integrate with Hosted Solution to add transaction processing to their website. The solution is built on the Payflow stack.

scroll to top