2012

IPN Guide July 10, 2012 61
IPN Variable Reference
Pay Message Variables
status The status of the payment. Possible values are:
 CREATED – The payment request was received; funds will be transferred
once the payment is approved
 COMPLETED – The payment was successful
 INCOMPLETE – Some transfers succeeded and some failed for a parallel
payment or, for a delayed chained payment, secondary receivers have not
been paid
 ERROR – The payment failed and all attempted transfers failed or all
completed transfers were successfully reversed
 REVERSALERROR – One or more transfers failed when attempting to
reverse a payment
 PROCESSING – The payment is in progress
 PENDING – The payment is awaiting processing
sender_email Sender’s email address.
action_type Whether the Pay API is used with or without the SetPaymentOptions and
ExecutePayment API operations. Possible values are:
 PAY – If you are not using the SetPaymentOptions and
ExecutePayment API operations
 CREATE – If you are using the SetPaymentOptions and
ExecutePayment API operations
payment_request_date The date on which the payment request was initiated.
reverse_all_parallel_pay
ments_on_error
Whether the payment request specified to reverse parallel payments if an error
occurs. Possible values are:
 true – Each parallel payment is reversed if an error occurs
 false – Only incomplete payments are reversed (default)
transaction[n].id The transaction ID, where [n] is a number from 0 to 5. For simple, single
receiver payments, this number will be 0. Numbers larger than 0 indicate the
payment to a particular receiver in chained and parallel payments.
transaction[n].status The transaction status, where [n] is a number from 0 to 5. For simple single-
receiver payments, this number will be 0. Numbers larger than 0 indicate the
payment to a particular receiver in chained and parallel payments.
Possible values are:
 Completed
 Pending
 Refunded
transaction[n].id_for_se
nder
The transaction ID for the sender, where [n] is a number from 0 to 5. For
simple, single receiver payments, this number will be 0. Numbers larger than 0
indicate the payment to a particular receiver in chained and parallel payments.
Variable Description