Mass Pay

Merchants can use the Mass Pay API to send money instantly to up to 250 recipients at once. To send payments to multiple recipients, merchants only need the recipient's PayPal account email address, the payment amount, and the currency code. Merchants can manually upload a file listing payments or create them programmatically using the Mass Pay API.

Applicable Use Cases

How it works

Merchants can use one of these methos to send batched payments:

Note: Mass payments are now invite only and criteria vary by sending country.

  • Upload a CSV file. You can upload a data file of up to 5,000 records that contains the recipient's PayPal account email address, payment amount, and currency code. You can add a fourth column for transaction IDs and a fifth column for a custom message for each recipient.
  • Use the PayPal MassPay API. You can programmatically use the MassPay API to make up to 250 payments per request. You can send payments to an email address or a PayPal customer account number. The MassPay API returns a response by using Instant Payment Notification (IPN) to the NotifyURL that you specify in your account. Detailed transaction data is stored in the your PayPal account history.

Why use Mass Pay

Implementing Mass Pay enables you to:

  • Make batched payments in a matter of hours and give recipients instant access to their money. Unlike checks, there's no waiting.
  • Minimize accounting paperwork by downloading transaction history. It's easy to reconcile exceptions by automatically returning payments that weren't claimed.
  • Save the recipient money on fees. With Mass Payment transactions, the sender pays a nominal fee, not the recipient. For example, affiliate partners do not pay a commission on the payments they receive, no matter how small the amount.

You can use Mass Pay for:

  • Marketplace payouts
  • Affiliate commissions
  • Customer rebates
  • Prizes and incentives
  • Pay-to-surf rewards
  • Employee benefits
  • Survey incentives

How to get started

  1. Check your account status. Log into PayPal. Click the Profile icon at the top right, and then select Profile and settings from the Business Profile menu. (If you do not see the profile icon at the top of the page, select Profile which appears in the top menu when the My Account tab is selected.) In the left menu, click My settings to confirm that your Account Type is either Premier or Business, or upgrade your account.
  2. Check your API settings. Log into PayPal and access your profile as described in the preceding step. In the left menu, click My selling tools. In the Selling online section, click Update next to API access, and then click the Request API credentials link to request an API signature or certificate. If you have already established your API signature or certificate, click the View API Signature or View API Certificate link to verify your API access.
  3. Contact your local PayPal customer account representative to be granted access after a quick identification check.
  4. Make sure that you have enough money in your PayPal account to cover the payment. If you are sending payments in different currencies, verify that your PayPal balance for each currency covers the amount you want to send.
  5. Upload a .CSV Mass Payment file or initiate a PayPal MassPay API request for each currency you are sending.
  6. Test your integration using the PayPal Sandbox, as described in Testing NVP/SOAP API Calls.

After you verify that your implementation works correctly in the Sandbox, make sure you have been granted live Mass Pay access. For complete details, see the documentation linked on this page.

Note: Because PayPal makes Mass Payments almost instantly, you can't cancel payments and Purchase Protection is not available.

Fees

There are no set-up costs or monthly fees to send Mass Payments.

Mass Payment Sending fees vary by sending country, and are calculated as a percentage of each transaction and are capped. The variable component typically is 2%, while the cap typically is different for domestic payments versus international payments. The cap is specific to the currency being sent, and is roughly equivalent across currencies for a given sending and receiving country pair. Recipients do not incur Mass Pay fees. Be sure to review your country's MassPay fees. To get you started, log into your PayPal account and review the US fee structure here.

International availability

You can make Mass Payments from any PayPal sending country and you can send to any PayPal receiving country in PayPal supported currencies. For further details, see country and currency.

Currency restrictions do not allow conversion of Argentine Pesos, Brazilian Real, or Malaysian Ringgit.

PayPal currency conversion rates apply should the sender or the recipient choose to convert the payments.

Countries with Currency Restrictions

If you are a PayPal account holder in a country with currency restrictions, make sure that your Adaptive Payment code or Mass Pay file contains requests that meet your country's requirements. If any of the Mass Pay entries do not comply with the country's restrictions, those entries will fail with an error message.

The following table lists the countries with currency restrictions and describes the restrictions that apply to Adaptive Payments and Mass Payments.

Country Currency Code Restrictions
Argentina ARS

Argentine users can:

  • Send payments in ARS only to other Argentine users
  • Send payments in other currencies to all users, including those in Argentina.

Argentine users cannot:

  • Send payments in ARS to users outside of Argentina
  • Send payments that result in currency conversion to or from ARS.

Note Non-Argentine users cannot hold currency balances in ARS.

Brazil BRL

Brazilian users can:

  • Send payments in BRL only to other Brazilian users.
  • Send payments in other currencies only to those outside Brazil.

Brazilian users cannot:

  • Send payments to other Brazilian users in a currency other than BRL.
  • Send payments that result in currency conversion to or from BRL.

Note Non-Brazilian users cannot hold currency balances in BRL.

Malaysia MYR

Malaysian users can:

  • Send payments in MYR only to other Malaysian users.
  • Send payments in other currencies to all users, including those in Malaysia.

Malaysian users cannot:

  • Send payments that result in currency conversion to or from MYR.
  • Send MYR balances to non-Malaysian users.

Note Non-Malaysian users cannot hold currency balances in MYR.

Developer and Merchant Support

Join the PayPal Partner Program

Join the North America Partner Program and enjoy many valuable benefits, including access to solutions integration information, marketing tools and a listing in our Partner Directory. It's free to join! For details, visit the Partner Program website.

Getting Started

Development and Integration

API References

  • MassPay API Operation (NVP, SOAP)

SDKs

  • You can choose to download the Merchant API SDKs. See NVP/SOAP API SDKs for information about the SDKs.

Forums to Follow