User Guide

IPN Variable Reference
Recurring Payments Variables
52 June, 2009 IPN Guide
Recurring Payments Variables
Recurring payments information identifies the amounts and status associated with recurring
payments transactions.
payment_status Completed: For Mass Payments, this means that all of your payments
have been claimed, or after a period of 30 days, unclaimed payments have
been returned to you.
Denied: For Mass Payments, this means that your funds were not sent
and the Mass Payment was not initiated. This may have been caused by
lack of funds.
Processed: Your Mass Payment has been processed and all payments
have been sent.
reason_code This variable is only set if status = Failed.
1001: Invalid UserID.
1003: Country of Residence check failure
1004: Country of Funding Source check failure
receiver_email_
x For Mass Payments, the primary email address of the payment recipient,
where
x is the record number of the mass pay item
Length: 127 characters
status_
x For Mass Payments, the status of the payment, where x is the record
number
Completed: The payment has been processed, regardless of whether this
was originally a unilateral payment
Failed: The payment failed because of insufficient PayPal balance.
Returned: Payment has been returned after 30 days.
Reversed: This is for unilateral payments that were not claimed after 30
days and have been returned to the sender. Or the funds have been
returned because the Receiver’s account was locked.
Unclaimed: This is for unilateral payments that are unclaimed.
unique_id_
x For Mass Payments, the unique ID from input, where x is the record
number. This allows the merchant to cross-reference the payment
Length: 13 characters
Variable Name Description
amount Amount of recurring payment
amount_per_cycle Amount of recurring payment per cycle
initial_payment_amount Initial payment amount for recurring payments
next_payment_date Next payment date for a recurring payment
Variable Name Description