Development & Integration Guides

Note: The links above provide access to the latest versions of the development and integration guides. To view documentation for previous versions of PayPal products, see the Documentation Archive.

Adaptive Accounts

Get Started (HTML)
Adaptive Accounts Developer Guide (HTML)
The Adaptive Accounts API lets you build applications that create PayPal accounts and handle account management.

Adaptive Payments

Get Started (HTML)
Adaptive Payments Developer Guide (HTML)
The Adaptive Payments API enables you to send money in many different scenarios, from simple to complex. For example, you might build a small send money application for a social networking site or a robust payroll system.

Express Checkout

Get Started (HTML)
Integration Overview (PDF | HTML)
Express Checkout Integration Guide (HTML)
Learn the basics of how to integrate Express Checkout with your website. See where Express Checkout goes on your site. Learn where your site needs to call the API.

Express Checkout Advanced Features Guide
English: HTML
Japanese: PDF
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.

Digital Goods Integration Guide - Express Checkout Edition (HTML)
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 New Updated PayPal Checkout Experience (PDF)
Learn about the new updated PayPal Checkout experience for Express Checkout. This guide provides the programming variables to customize the new updated checkout user interface.

Name-Value Pair API Developer Guide and Reference (HTML)
Learn how to use the Name-Value Pair API. Includes code samples, an API reference, information on SDKs, and web samples.

SOAP API Developer Reference (HTML)
Programmers familiar with SOAP (Simple Object Access Protocol) can learn more about the PayPal SOAP API.

Sandbox User Guide (HTML)
Learn how to test your PayPal-based applications before using them in production with the Sandbox, PayPal's virtual test environment.

Express Checkout User Interface Standards (PDF)
Express Checkout User Interface Standards details the requirements and best practices for placing PayPal graphic images on your website. It also explains how buyers who pay with PayPal will experience 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 Edition) Fraud Management Filters for PayPal Payments Pro (Direct Integration)
Payflow Fraud Protection Services User's Guide (PDF)
How to integrate the Fraud Protection Services into your Payflow solution.
Fraud Management Filters (HTML)
How to use Fraud Management filters.

Invoicing Service

Get Started (HTML)
Invoicing Service API Guide (HTML)
You can use the Invoicing Service API to create, send, and manage invoices using PayPal. View Invoicing Service API examples, along with information on API references.

Mass Payments

Get Started (HTML)
Mass Payments User Guide (HTML)
Learn how to use Mass Payments to send multiple payments in one batch.

Merchant Setup and Administration Guide

Merchant Setup and Administration Guide (PDFHTML)
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, getting contact numbers from payers, and working with transaction history.

Payflow Gateway

Get Started (HTML)
Payflow Gateway Developer's Guide (PDF)
Payflow Gateway enables you to use hosted checkout pages with the Payflow SDK to integrate the Payflow payments solution into your website or application. 

Express Checkout for Payflow Pro (PDF)
How to integrate Express Checkout for Payflow Gateway.

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

Payflow Gateway Reporting Developer's Guide (PDF)
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 (PDF
A list of compatible processors for Payflow and the fields required to enable transactions for each processor.

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

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

Payflow ACH Payment Service Guide (PDF)
How to implement Automated Clearinghouse (ACH) with Payflow Gateway.

E-Commerce and Web Server Integrations (HTML)
E-commerce and Web server applications that have integrated with Payflow Pro.

Moneris Receipts Specification (PDF)
Describes 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.

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.

Accept payments on mobile devices

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 so you don't need to worry about PCI compliance.

In addition to the native Mobile SDKs, the Windows 8 Checkout SDK provides a way to add PayPal buttons to Windows 8 Store and Windows Phone applications.

Mobile PayPal Payments Standard

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.

Learn More

PayPal Mobile Express Checkout

If you have a mobile website, you can integrate our Mobile Express Checkout (MEC) APIs to redirect the buyer to the PayPal mobile website for the checkout flow. 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.

Learn more | Get Started | Express Checkout Integration Guide

Features and Benefits

If you need more help deciding between the various solutions, heres's a quick break-down of the features and benefits.

Feature MPPS MEC
In-app payment
Runs without back-end API integration +
Quick integration + +
Credit card checkout (no PayPal account needed) + +
Supports auth/settle payments +
Supports Recurring Payments +

PayPal Payments Advanced (US & Canada only)

Get Started (HTML)

Payflow Gateway Developer's Guide  (PDF)
Payflow Gateway enables you to use hosted checkout pages with the Payflow SDK to integrate the Payflow payments solution into your website or application.

Embedded Checkout Design Guide (PDF)

Configuring PayPal Payments Advanced for Partners (PDF)

Payflow Gateway Reporting Developer's Guide (PDF)
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 Pro

PayPal Payments Pro (Also known as Website Payments Pro outside the US) enables merchants and developers to accept credit cards, debit cards, and PayPal payments directly on their website. PayPal Payments Pro also includes Express Checkout and Virtual Terminal. Add-on services like Recurring Billing are also available.

PayPal Payments Pro is available in two versions. Please select your documentation & integration guides based on the version below:

PayPal Payments Pro (Payflow Edition)
RECOMMENDED

Use Payflow SDK (as a .NET or JAVA library) or make direct secure API calls to the servers.

View the current version of the product available here.

PayPal Payments Pro (Direct Payment)
(Website Payments Pro in Canada and the UK)

DoDirectPayment API credentials or signature

Payflow Gateway Developer's Guide (PDF)
How to develop your payment solution.

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

Express Checkout for Payflow (PDF)
How to integrate Express Checkout for the Payflow Gateway.

Express Checkout Advanced Features GuideEnglish: HTML
Japanese: PDF
Learn about advanced features that enhance your integration of Express Checkout. To get started using Express Checkout, see the PayPal Payments Pro Integration Guide, above.

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

Name-Value Pair API Developer Guide and Reference (HTML)
Learn how to use the Name-Value Pair API. Includes code samples, an API reference, information on SDKs, and web samples.

Payflow Gatway Reporting Developer's Guide (PDF)
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.

SOAP API Developer Reference (HTML)
Programmers familiar with SOAP (Simple Object Access Protocol) can learn more about the PayPal SOAP API.

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

Recurring Payments (HTML)
How to use Recurring Payments for PayPal Payments Pro (Direct Integration)

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

Fraud Management Filters (HTML)
How to use Fraud Management filters

Payflow ACH Payment Service Guide (PDF)
How to implement Automated Clearinghouse (ACH) with Payflow.

Sandbox User Guide (HTML)
Learn how to test your PayPal-based applications before using them in production with the Sandbox, PayPal's virtual test environment.

E-Commerce and Web Server Integrations (HTML)
E-commerce and Web server applications that have integrated with Payflow.

PayPal Payments Pro for UK and Canada (PDFHTML)
See a list of the minor regional differences for PayPal Payments Pro.

PayPal Payments Standard

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

Preparing for the New Updated PayPal Checkout Experience (PDF)
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 (HTML)
Learn how to test your PayPal-based applications before using them in production with the Sandbox, PayPal's virtual test environment.

NVP Button Manager API (HTML)
This document is intended for merchants implementing PayPal Payment Standard buttons using the NVP API.

SOAP Button Manager API (HTML)
This document is intended for merchants implementing PayPal Payment Standard buttons using the SOAP API.

Merchant Gift Certificates Guide (PDF)
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 (HTML)
Permissions Service Guide (HTML)
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 the merchants to bill a buyer for a fixed amount of money on a fixed schedule.

Please select your documentation based on the product below:

Recurring Billing for Payflow Gateway Recurring Payments for PayPal Payments Pro (Direct Integration)

Payflow Recurring Billing User's Guide (PDF)
How to integrate the Recurring Billing service into your Payflow solution

Recurring Payments (HTML)
How to use Recurring Payments for PayPal Payments Pro (Direct Integration)

Reporting

How To Search for Transaction Data using the Merchant API (HTML)
Learn how to use the TransactionSearch and GetTransactionDetails API operations of the Merchant API to lookup transaction information.

Instant Payment Notification (IPN) Guide (HTML)
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 (HTML)
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 chapter of the IPN integration guide).

Payflow Gatway Reporting Developer's Guide (PDF)
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 Reports
For a comprehensive list of merchant report guides, see the Reporting product page.

Website Payments Pro Hosted Solution (Outside the US)

Website Payments Pro Hosted Solution Integration Guide

This guide is for merchants and developers that 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
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 that want to integrate with Hosted Solution to add transaction processing to their website. The solution is build on Payflow stack.