Business::PayPal::API::MassPay.3pm

Langue: en

Version: 2009-12-07 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

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

SYNOPSIS

   use Business::PayPal::API::MassPay;
 
   ## see Business::PayPal::API documentation for parameters
   my $pp = new Business::PayPal::API::MassPay ( ... );
 
   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>

AUTHOR

Scot Wiersdorf <scott@perlcode.org> Copyright (C) 2007 by Scott Wiersdorf

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available.