User Guide

Table Of Contents

IPN Guide July 10, 2012 63

IPN Variable Reference

Preapproval Message Variables

PayPal generates an IPN message that contains information about a preapproval in response to

the Adaptive Payments Preapproval API operation.

fees_payer The payer of PayPal fees. Possible values are:

 SENDER – Sender pays all fees (for personal, implicit simple/parallel

payments; do not use for chained or unilateral payments)

 PRIMARYRECEIVER – Primary receiver pays all fees (chained payments

only)

 EACHRECEIVER – Each receiver pays their own fee (default, personal and

unilateral payments)

 SECONDARYONLY – Secondary receivers pay all fees (use only for chained

payments with one secondary receiver)

trackingId The tracking ID that was specified for this payment in the

PaymentDetailsRequest message.

preapproval_key The preapproval key returned after a PreapprovalRequest, or the

preapproval key that identifies the preapproval key sent with a PayRequest.

reason_code Whether this transaction is a chargeback, partial, or reversal. Possible values

are:

 Chargeback Settlement – Transaction is a chargeback

 Admin reversal – Transaction was reversed by PayPal administrators

 Refund – Transaction was partially or fully refunded

Variable Description

transaction_type The type of transaction. For a preapproval, this variable returns Adaptive

Payment Preapproval.

NOTE: If this variable is set to Adaptive Payment Pay or Adjustment,

refer to the Pay Message Variable section.

preapproval_key The preapproval key returned after a PreapprovalRequest.

approved Whether the preapproval request was approved. Possible values are:

 true – The preapproval was approved

 false – The preapproval was denied

cancel_url The URL to which the sender’s browser is redirected if the sender decides to

cancel the preapproval as requested. Use the preapproval key to identify the

payment as follows: preapprovalKey=${preapprovalKey}

current_number_of_paymen

The current number of payments made for this preapproval.

Variable Description