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 February 2012 23
Using the Mass Payments API
MassPay API Using NVP
3
SOAP MassPay Request Fields
SOAP MassPay Response Message
The elements returned are the same as for AbstractResponseType.
MassPay API Using NVP
The following is a sample MassPay API call to two recipients using the PayPal Name-Value
Pair (NVP) API. The recipients are specified by email address.
Field Description
EmailSubject xs:string
(Optional) The subject line of the email that PayPal sends when the transaction is
completed. The subject line is the same for all recipients.
Character length and limitations: 255 single-byte alphanumeric characters.
MassPayItem ebl:MassPayItemType
(Required) Details of each payment.
NOTE: A single MassPayRequest can include up to 250 MassPayItems.
ReceiverType ebl:ReceiverInfoCodeType
(Optional) Indicates how you identify the recipients of payments in this call to
MassPay.
Must be EmailAddress or UserID