Integration Guide
Table Of Contents
- Order Management Integration Guide
- Preface
- Introduction
- Payment Data Transfer
- Instant Payment Notification (IPN)
- Transaction History and Reporting Tools
- IPN and PDT Variables
- About These Tables of Variables
- test_ipn Variable in Sandbox
- IPN Variables in All Posts
- Buyer Information
- Basic Information
- Advanced and Custom Information
- Website Payments Standard and Refund Information
- Currency and Currency Exchange
- Auctions
- Mass Payment
- Dispute Notification Variables
- PDT-Specific Variables
- Downloadable History Log Columns and Values
- Index
Order Management Integration Guide October 2006 3
Contents
Chapter P Preface . . . . . . . . . . . . . . . . . . . . . . . . . . .11
This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Organization of This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Documentation Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . .15
Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Reporting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Differences between Instant Payment Notification (IPN) and Payment Data Transfer (PDT) 16
SSL Not Required for IPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
PayPal-Supported Transactional Currencies . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 2 Payment Data Transfer . . . . . . . . . . . . . . . . . . .19
How PDT Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Enabling Payment Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Getting and Using the Identity Token . . . . . . . . . . . . . . . . . . . . . . . . . . 24
PDT Notification Synch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Constructing the POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
PayPal Response to POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
PDT and Auto Return: Messaging to Buyer . . . . . . . . . . . . . . . . . . . . . . . 26
Preventing Fraud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Code Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 3 Instant Payment Notification (IPN) . . . . . . . . . . . . .29
About IPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Setting Up IPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Activating IPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Setting Up an IPN-Processing Program . . . . . . . . . . . . . . . . . . . . . . . . . 31