| Business::PayPal::API::RefundTransaction(3pm) | User Contributed Perl Documentation | Business::PayPal::API::RefundTransaction(3pm) |
Business::PayPal::API::RefundTransaction - PayPal RefundTransaction API
version 0.77
use Business::PayPal::API::RefundTransaction;
## see Business::PayPal::API documentation for parameters
my $pp = Business::PayPal::API::RefundTransaction->new( ... );
my %response = $pp->RefundTransaction(
TransactionID => $transid,
RefundType => 'Full',
Memo => "Please come again!"
);
Business::PayPal::API::RefundTransaction implements PayPal's RefundTransaction 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.
Implements PayPal's RefundTransaction API call. Supported parameters include:
TransactionID RefundType (defaults to 'Full' if not supplied) Amount Memo currencyID (defaults to 'USD' if not supplied)
as described in the PayPal "Web Services API Reference" document. The default currencyID setting is 'USD' if not otherwise specified. The default RefundType setting is 'Full' if not otherwise specified.
If RefundType is set to 'Full', Amount is ignored (even if set). If RefundType is set to 'Partial', Amount is required.
Returns a hash containing the results of the transaction. The Ack element is likely the only useful return value at the time of this revision (the Nov. 2005 errata to the Web Services API indicates that the documented fields 'TransactionID', 'GrossAmount', etc. are not returned with this API call).
Example:
my %resp = $pp->RefundTransaction( TransactionID => $trans_id,
RefundType => 'Partial',
Amount => '15.00', );
unless( $resp{Ack} !~ /Success/ ) {
for my $error ( @{$response{Errors}} ) {
warn "Error: " . $error->{LongMessage} . "\n";
}
}
See the ERROR HANDLING section of Business::PayPal::API for information on handling errors.
None by default.
<https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
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.
| 2022-08-28 | perl v5.34.0 |