1Business::PayPal::API::URseefrunCdoTnrtarnisbauctBteuidsoinPn(ee3rs)ls:D:oPcauymPeanlt:a:tAiPoIn::RefundTransaction(3)
2
3
4
6 Business::PayPal::API::RefundTransaction - PayPal RefundTransaction API
7
9 version 0.77
10
12 use Business::PayPal::API::RefundTransaction;
13
14 ## see Business::PayPal::API documentation for parameters
15 my $pp = Business::PayPal::API::RefundTransaction->new( ... );
16
17 my %response = $pp->RefundTransaction(
18 TransactionID => $transid,
19 RefundType => 'Full',
20 Memo => "Please come again!"
21 );
22
24 Business::PayPal::API::RefundTransaction implements PayPal's
25 RefundTransaction API using SOAP::Lite to make direct API calls to
26 PayPal's SOAP API server. It also implements support for testing via
27 PayPal's sandbox. Please see Business::PayPal::API for details on using
28 the PayPal sandbox.
29
30 RefundTransaction
31 Implements PayPal's RefundTransaction API call. Supported parameters
32 include:
33
34 TransactionID
35 RefundType (defaults to 'Full' if not supplied)
36 Amount
37 Memo
38 currencyID (defaults to 'USD' if not supplied)
39
40 as described in the PayPal "Web Services API Reference" document. The
41 default currencyID setting is 'USD' if not otherwise specified. The
42 default RefundType setting is 'Full' if not otherwise specified.
43
44 If RefundType is set to 'Full', Amount is ignored (even if set). If
45 RefundType is set to 'Partial', Amount is required.
46
47 Returns a hash containing the results of the transaction. The Ack
48 element is likely the only useful return value at the time of this
49 revision (the Nov. 2005 errata to the Web Services API indicates that
50 the documented fields 'TransactionID', 'GrossAmount', etc. are not
51 returned with this API call).
52
53 Example:
54
55 my %resp = $pp->RefundTransaction( TransactionID => $trans_id,
56 RefundType => 'Partial',
57 Amount => '15.00', );
58
59 unless( $resp{Ack} !~ /Success/ ) {
60 for my $error ( @{$response{Errors}} ) {
61 warn "Error: " . $error->{LongMessage} . "\n";
62 }
63 }
64
65 ERROR HANDLING
66 See the ERROR HANDLING section of Business::PayPal::API for information
67 on handling errors.
68
69 EXPORT
70 None by default.
71
73 <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
74
76 • Scott Wiersdorf <scott@perlcode.org>
77
78 • Danny Hembree <danny@dynamical.org>
79
80 • Bradley M. Kuhn <bkuhn@ebb.org>
81
83 This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny
84 Hembree, Bradley M. Kuhn.
85
86 This is free software; you can redistribute it and/or modify it under
87 the same terms as the Perl 5 programming language system itself.
88
89
90
91perl v5.32.1 20B2u1s-i0n1e-s2s6::PayPal::API::RefundTransaction(3)