NAME

Business::PayPal::API::MassPay - PayPal MassPay API

VERSION

version 0.77

SYNOPSIS

            

              
              
use Business::PayPal::API::MassPay;
## see Business::PayPal::API documentation for parameters
my $pp = Business::PayPal::API::MassPay->new( ... );
my %response = $pp->MassPay(
    EmailSubject => "Here's your moola",
    MassPayItems => [
        {   ReceiverEmail => 'joe@somewhere.tld',
            Amount        => '95.44',
            Note          => 'Thanks for your stuff!'
        },
        {   ReceiverEmail => 'bob@elsewhere.tld',
            Amount        => '15.31',
            Note          => 'We owe you one'
        },
    ]
);
            
          

DESCRIPTION

Business::PayPal::API::MassPay implements PayPal's Mass Pay API using SOAP::Lite to make direct API calls to PayPal's SOAP API server. It also implements support for testing via PayPal's sandbox. Please see Business::PayPal::API for details on using the PayPal sandbox.

MassPay

Implements PayPal's Mass Pay API call. Supported parameters include:

            

              
              
EmailSubject
MassPayItems
            
          

The MassPayItem parameter is a list reference of hashrefs, each containing the following fields:

            

              
              
ReceiverEmail
Amount
UniqueId
Note
            
          

as described in the PayPal "Web Services API Reference" document.

Returns a hash containing the generic response structure (as per the PayPal Web Services API).

Example:

            

              
              
my %resp = $pp->MassPay( EmailSubject => "This is the subject",
                         MassPayItems => [ { ReceiverEmail => 'joe@test.tld',
                                             Amount => '24.00',
                                             UniqueId => "123456",
                                             Note => "Enjoy the money. Don't spend it all in one place." } ] );
unless( $resp{Ack} !~ /Success/ ) {
  die "Failed: " . $resp{Errors}[0]{LongMessage} . "\n";
}
            
          

ERROR HANDLING

See the ERROR HANDLING section of Business::PayPal::API for information on handling errors.

EXPORT

None by default.

SEE ALSO

https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf

AUTHORS

• Scott Wiersdorf <scott@perlcode.org>

• Danny Hembree <danny@dynamical.org>

• Bradley M. Kuhn <bkuhn@ebb.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny Hembree, Bradley M. Kuhn.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.