1Business::PayPal::API::UMsaesrsPCaoyn(t3r)ibuted Perl DoBcuusmiennetsast:i:oPnayPal::API::MassPay(3)
2
3
4

NAME

6       Business::PayPal::API::MassPay - PayPal MassPay API
7

VERSION

9       version 0.77
10

SYNOPSIS

12           use Business::PayPal::API::MassPay;
13
14           ## see Business::PayPal::API documentation for parameters
15           my $pp = Business::PayPal::API::MassPay->new( ... );
16
17           my %response = $pp->MassPay(
18               EmailSubject => "Here's your moola",
19               MassPayItems => [
20                   {   ReceiverEmail => 'joe@somewhere.tld',
21                       Amount        => '95.44',
22                       Note          => 'Thanks for your stuff!'
23                   },
24                   {   ReceiverEmail => 'bob@elsewhere.tld',
25                       Amount        => '15.31',
26                       Note          => 'We owe you one'
27                   },
28               ]
29           );
30

DESCRIPTION

32       Business::PayPal::API::MassPay implements PayPal's Mass Pay API using
33       SOAP::Lite to make direct API calls to PayPal's SOAP API server. It
34       also implements support for testing via PayPal's sandbox. Please see
35       Business::PayPal::API for details on using the PayPal sandbox.
36
37   MassPay
38       Implements PayPal's Mass Pay API call. Supported parameters include:
39
40         EmailSubject
41         MassPayItems
42
43       The MassPayItem parameter is a list reference of hashrefs, each
44       containing the following fields:
45
46         ReceiverEmail
47         Amount
48         UniqueId
49         Note
50
51       as described in the PayPal "Web Services API Reference" document.
52
53       Returns a hash containing the generic response structure (as per the
54       PayPal Web Services API).
55
56       Example:
57
58         my %resp = $pp->MassPay( EmailSubject => "This is the subject",
59                                  MassPayItems => [ { ReceiverEmail => 'joe@test.tld',
60                                                      Amount => '24.00',
61                                                      UniqueId => "123456",
62                                                      Note => "Enjoy the money. Don't spend it all in one place." } ] );
63
64         unless( $resp{Ack} !~ /Success/ ) {
65           die "Failed: " . $resp{Errors}[0]{LongMessage} . "\n";
66         }
67
68   ERROR HANDLING
69       See the ERROR HANDLING section of Business::PayPal::API for information
70       on handling errors.
71

EXPORT

73       None by default.
74

SEE ALSO

76       <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
77

AUTHORS

79       •   Scott Wiersdorf <scott@perlcode.org>
80
81       •   Danny Hembree <danny@dynamical.org>
82
83       •   Bradley M. Kuhn <bkuhn@ebb.org>
84

86       This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny
87       Hembree, Bradley M. Kuhn.
88
89       This is free software; you can redistribute it and/or modify it under
90       the same terms as the Perl 5 programming language system itself.
91
92
93
94perl v5.38.0                      2023-07-20 Business::PayPal::API::MassPay(3)
Impressum