Integration Guide
Table Of Contents
- Express Checkout Integration Guide
- Contents
- Preface
- Introducing Express Checkout
- Express Checkout Button and Logo Image Integration
- PayPal Name-Value Pair API Basics
- Implementing the Simplest Express Checkout Integration
- Testing an Express Checkout Integration
- Customizing Express Checkout
- Implementing the Instant Update API
- Immediate Payment
- Handling Payment Settlements
- Handling Recurring Payments
- How Recurring Payments Work
- Recurring Payments Terms
- Recurring Payments With Express Checkout
- Options for Creating a Recurring Payments Profile
- Recurring Payments Profile Status
- Getting Recurring Payments Profile Information
- Modifying a Recurring Payments Profile
- Billing the Outstanding Amount of a Profile
- Recurring Payments Notifications
- Using Other PayPal API Operations
- Integrating giropay with Express Checkout
Contents
4 October 2009
Dynamic Image Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Dynamic Image Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Locale Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Static PayPal Buttons and Images Source Requirements . . . . . . . . . . . . . . . . . . 23
Chapter 3 PayPal Name-Value Pair API Basics . . . . . . . . . . . . .25
PayPal API Client-Server Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
PayPal Name-Value Pair API Requests and Responses . . . . . . . . . . . . . . . . 25
Multiple API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Obtaining API Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Creating an API Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Creating an API Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Creating an NVP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Specifying the PayPal API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Specifying an API Credential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
URL Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
List Syntax for Name-Value Pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Executing NVP API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Specifying a PayPal Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Logging API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Responding to an NVP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Common Response Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
URL Decoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Chapter 4 Implementing the Simplest Express Checkout Integration .35
Setting Up the Express Checkout Transaction. . . . . . . . . . . . . . . . . . . . . . . . 35
Obtaining Express Checkout Transaction Details . . . . . . . . . . . . . . . . . . . . . . 37
Completing the Express Checkout Transaction . . . . . . . . . . . . . . . . . . . . . . . 37
Chapter 5 Testing an Express Checkout Integration . . . . . . . . . .39
Chapter 6 Customizing Express Checkout . . . . . . . . . . . . . . .45
PayPal Review Page Order Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Special Instructions to Merchant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Integrating Order Details into the Express Checkout Flow . . . . . . . . . . . . . . . 48
eBay-Issued Incentives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Integrating eBay Incentives into the Express Checkout Flow . . . . . . . . . . . . . . 52