Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 259
Instant Payment Notifications
Pay Message Variables
transaction[n].status_fo
r _sender_txn
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 – The sender’s transaction has completed
 PENDING – The transaction is awaiting further processing
 CREATED – The payment request was received; funds will be transferred
once approval is received
 PARTIALLY_REFUNDED– Transaction was partially refunded
 DENIED – The transaction was rejected by the receiver
 PROCESSING – The transaction is in progress
 REVERSED – The payment was returned to the sender
 REFUNDED – The payment was refunded
 FAILED – The payment failed
transaction[n].refund_id The identification number for the refund
transaction[n].refund_am
ount
The amount that was refunded.
transaction[n].refund_ac
count_charged
The email address of the debit account of the refund.
transaction[n].receiver The receiver’s email address for the transaction
transaction[n].invoiceId The invoice number for this transaction
transaction[n].amount The payment amount of the transaction
transaction[n].is_primar
y_receiver
Whether there is a primary receiver for this transaction, which indicates
whether the transaction is a chained payment.
Possible values are:
 true – There is a primary receiver (chained payment)
 false – There is no primary receiver (simple or parallel payment)
return_url The URL to which the sender’s browser is redirected after approving a
payment on paypal.com. Use the pay key to identify the payment as follows:
payKey=${payKey}.
cancel_url The URL to which the sender’s browser is redirected if the sender cancels the
approval for a payment on paypal.com. Use the pay key to identify the
payment as follows: payKey=${payKey}.
ipn_notification_url The URL to which all IPN messages for this payment are sent.
pay_key The pay key that identifies this payment. This is a token that is assigned by the
Pay API after a PayRequest message is received and can be used in other
Adaptive Payments APIs as well as the cancelURL and returnURL to
identify this payment. The pay key is valid for 3 hours.
memo A note associated with the payment.
Variable Description