User Guide
Table Of Contents
- Mass Payments User Guide
- Contents
- Preface
- Mass Payments Overview
- Using Mass Payments in Your PayPal Account
- Using the Mass Payments API
- Mass Payments Reporting
- About Mass Payments Reporting
- Using the Reports Dashboard to Review Mass Payment Transactions
- Using Account History to Review Mass Payment Transactions
- Viewing Transaction Logs
- Downloading History Logs
- Receiving Instant Payment Notifications for Mass Payments
- Using the Settlement Report and the Transaction Detail Report
- Best Practices and FAQs for Mass Payments
- Mass Payments FAQs
- Is there a fee to send Mass Payments?
- How much money can I send?
- What countries can receive Mass Payments?
- Can I send money in different currencies?
- How do I confirm the receipt of payments?
- How do I cancel an individual payment?
- A recipient told me that payment was not received. What could be the problem?
- What does it mean if a mass payment is “Processing, Denied, Processed or Completed” in my transaction history?
- Mass Payments FAQs
- Currencies and Currency Codes
Mass Payments User Guide January 2013 21
3
Using the Mass Payments API
You can use the MassPay API to send Mass Payments.
For example, you can use the MassPay API if you need to generate Mass Payments
automatically, such as generating rebates every month based on information stored in a
customer database.
NOTE: For more information on using Mass Payments from your PayPal account, see “Using
Mass Payments in Your PayPal Account” on page 11.
Read the following topics to learn how to implement Mass Payments using the API.
“Calling the MassPay API” on page 21
“MassPay API Using SOAP” on page 22
“MassPay API Using NVP” on page 23
“MassPay Error Codes” on page 24
Calling the MassPay API
The MassPay API lets you send payments to up to 250 recipients with a single API call. You
specify the payment amount for each recipient individually, but you must use the same
currency type for all payments in a MassPay API request. You can identify recipients either by
email address, US mobile phone number, or their PayPal customer account number.
PayPal receives the MassPay request and returns a response indicating success or failure. If
PayPal returns a successful response, then PayPal processes the payments. If you have Instant
Payment Notifications (IPN) enabled, PayPal sends a notification to the Notify URL specified
in your account profile. If you do not have IPN enabled, you can view the details of the
MassPay transaction in your PayPal account.
The PayPal API is available in both a SOAP interface as well as a Name-Value Pair (NVP)
interface.
For information about using the MassPay API using the SOAP interface, see “MassPay API
Using SOAP” on page 22.
For information about the NVP interface, see “MassPay API Using NVP” on page 23.