Get Started

Mass Payments lets you send multiple payments in one batch. It's a fast and convenient way to send commissions, rebates, rewards, and general payments. You must have explicit permission from PayPal to use Mass Payments. You submit the payment information to PayPal in the form of a payment file. PayPal processes each payment and notifies you when it is complete.


The preferred way to install the library is using composer. Run composer require to add dependencies to composer.json:

php composer.phar require payum/paypal-masspay-nvp php-http/guzzle7-adapter



use Payum\Core\PayumBuilder;
use Payum\Core\Payum;

/** @var Payum $payum */
$payum = (new PayumBuilder())
    ->addGateway('aGateway', [
        'factory' => 'paypal_masspay',
        'username'  => 'change it',
        'password'  => 'change it',
        'signature' => 'change it',
        'sandbox'   => true,



Here we send 1$ to user:


use Payum\Core\Model\Payout;

include __DIR__.'/config.php';

$gatewayName = 'aGateway';

/** @var \Payum\Core\Payum $payum */
$storage = $payum->getStorage(Payout::class);

$payout = $storage->create();
$payout->setTotalAmount(100); // 1$

$payoutToken = $payum->getTokenFactory()->createPayoutToken($gatewayName, $payout, 'done.php');

header("Location: ".$payoutToken->getTargetUrl());

Supporting Payum

Payum is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:

Last updated