2012
Table Of Contents
- Instant Payment Notification Guide
- Contents
- Preface
- Introducing IPN
- Implementing an IPN Listener
- Identifying Your IPN Listener to PayPal
- IPN Testing
- IPN Operations on PayPal
- Using Fraud Management Filters With IPN
- IPN Variable Reference
- IPN Transaction Types
- Transaction and Notification-Related Variables
- Buyer Information Variables
- Payment Information Variables
- Auction Variables
- Mass Pay Variables
- Recurring Payments Variables
- Subscription Variables
- Dispute Resolution Variables
- Pay Message Variables
- Preapproval Message Variables
- Adaptive Accounts IPN Messages
- Payment Review Using Notifications
- Revision History
IPN Guide July 10, 2012 45
IPN Variable Reference
Payment Information Variables
auth_exp Authorization expiration date and time, in the following format:
HH:MM:SS DD Mmm YY, YYYY PST
Length: 28 characters
auth_id Authorization identification number
Length: 19 characters
auth_status Status of authorization
echeck_time_processed The time an eCheck was processed; for example, when the status changes
to Success or Completed. The format is as follows: hh:mm:ss MM DD,
YYYY ZONE, e.g. 04:55:30 May 26, 2011 PDT.
exchange_rate Exchange rate used if a currency conversion occurred.
fraud_managment_pending_fil
ters_
x
One or more filters that identify a triggering action associated with one of
the following payment_status values: Pending, Completed, Denied,
where
x is a number starting with 1 that makes the IPN variable name
unique;
x is not the filter’s ID number. The filters and their ID numbers
are as follows:
invoice Passthrough variable you can use to identify your Invoice Number for this
purchase. If omitted, no variable is passed back.
Length: 127 characters
item_name
x Item name as passed by you, the merchant. Or, if not passed by you, as
entered by your customer. If this is a shopping cart transaction, PayPal
will append the number of the item (e.g., item_name1, item_name2,
and so forth).
Length: 127 characters
item_number
x Pass-through variable for you to track purchases. It will get passed back to
you at the completion of the payment. If omitted, no variable will be
passed back to you. If this is a shopping cart transaction, PayPal will
append the number of the item (e.g., item_number1, item_number2,
and so forth)
Length: 127 characters
mc_currency
For payment IPN notifications, this is the currency of the payment.
For non-payment subscription IPN notifications (i.e., txn_type=
signup, cancel, failed, eot, or modify), this is the currency of the
subscription.
For payment subscription IPN notifications, it is the currency of the
payment (i.e., txn_type = subscr_payment)
mc_fee Transaction fee associated with the payment. mc_gross minus mc_fee
equals the amount deposited into the receiver_email account.
Equivalent to payment_fee for USD payments. If this amount is
negative, it signifies a refund or reversal, and either of those payment
statuses can be for the full or partial amount of the original transaction fee.
Variable Name Description