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
Using the Mass Payments API
MassPay API Using NVP
3
24 February 2012 Mass Payments User Guide
USER=fictionaluser.unknowncompany.com&
PWD=apiPassword&
SIGNATURE=AFcFxV21C7fd0v3bYYYRCpSSRl31ACInnLACIHV5EdPnjIVOlb1a6kn9&
VERSION=2.3&
METHOD=MassPay&
RECEIVERTYPE=EmailAddress&
L_EMAIL0=fred@unknowncompany.com&
L_AMT0=25.99&
L_EMAIL1=john@fictionalcompany.com&
L_AMT1=9.99&
CURRENCYCODE=USD
NOTE: Carriage returns have been added to the code example for easier reading.
For more information on implementing the MassPay API using NVP, see the
PayPal Name-
Value Pair API Developer Reference Guide.
The following sections contain a list and descriptions of the MassPay fields:
“NVP MassPay Request Message” on page 24
“NVP MassPay Response Message” on page 24
NVP MassPay Request Message
Mass Payments Request Fields
NVP MassPay Response Message
The fields in the response are the standard response header fields.
Field Description
METHOD (Required) Must be MassPay.
EMAILSUBJECT (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.
CURRENCYCODE A three-character currency code. See “Currencies and Currency Codes” on page 41.
RECEIVERTYPE (Optional) Indicates how you identify the recipients of payments in this call to
MassPay.
Must be EmailAddress or UserID