Integration Guide
Table Of Contents
- Preface
- Introduction
- Payment Data Transfer
- Instant Payment Notification (IPN)
- Downloadable History Log
- IPN and PDT Variables
- Data Type, Maximum Field Lengths, and URL Encoding
- About These Tables of Variables
- test_ipn Variable in Sandbox
- IPN Variables in All Posts
- Buyer Information
- Basic Information
- Advanced and Custom Information
- Shopping Cart Information
- Currency and Currency Exchange
- Auctions
- Mass Payment
- Subscriptions Variables
- Dispute Notification Variables
- PDT-Specific Variables
- Downloadable History Log Columns and Values
- Country Codes
IPN and PDT Variables
Mass Payment
48 August 2005
Mass Payment
TABLE A.6 IPN and PDT Variables: Mass Pay
Variable Name Possible Values Description
masspay_
txn_id_
x
For Mass Payments, a unique transaction ID generated by the PayPal system,
where
x is the record number of the mass pay item
mc_currency
_
x
Transaction-
specific for
multiple
currencies
For Mass Payments, the currency of the amount and fee, where
x is the record
number the mass pay item
mc_fee_
x Transaction-
specific for
multiple
Currencies
For Mass Payments, the transaction fee associated with the payment, where
x
is the record number the mass pay item
mc_gross_
x Transaction-
specific for
Multiple
Currencies
The gross amount for the amount, where
x is the record number the mass pay
item
payment_
date
For Mass Payments, the first IPN is the date/time when the record set is
processed and the second IPN is the date/time when all payments are
completed/returned
payment_fee
_
x
Transaction-
specific for
USD payments
only
If the payment is USD, then the value is the same as that for mc_fee_
x, where
x is the record number; if the currency is not USD, then this is an empty string.
payment_
gross_
x
Transaction-
specific for
USD payments
only
If the payment is USD, then the value for this is the same as that for the
mc_gross_
x, where x is the record number the mass pay item. If the currency
is not USD, this is an empty string.
payment_
status
Completed
Denied
Processed
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.
receiver_
email_
x
For Mass Pay payments, the primary email address of the payment recipient,
where
x is the record number the mass pay item