User Guide

IPN Guide June, 2009 3
Contents
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 1 Introducing IPN . . . . . . . . . . . . . . . . . . . . . . . 7
What is IPN? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
IPN Protocol and Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
IPN Messages Generated by Website Payments Standard . . . . . . . . . . . . . . . 10
IPN Messages Generated by PayPal APIs . . . . . . . . . . . . . . . . . . . . . . . 11
IPN Messages Generated by a Back-Office Procedure . . . . . . . . . . . . . . . . . 12
IPN Messages Generated by PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . 13
A Sample IPN Message and Response . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Non-IPN Notification Mechanisms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 2 Implementing an IPN Listener . . . . . . . . . . . . . . . .19
Chapter 3 Identifying Your IPN Listener to PayPal . . . . . . . . . . .23
Setting Up IPN Notifications on PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Dynamically Setting the Notification URL . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 4 IPN Testing . . . . . . . . . . . . . . . . . . . . . . . . .27
Testing Your Listener. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
IPN Troubleshooting Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 5 IPN Operations on PayPal . . . . . . . . . . . . . . . . . .31
Using the IPN History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Resending IPN Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 6 Using Fraud Management Filters With IPN . . . . . . . . .37
Chapter 7 IPN Variable Reference . . . . . . . . . . . . . . . . . . .41
IPN Transaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41