SYNOPSIS

  use Business::PayPal::API::RefundTransaction;

  ## see Business::PayPal::API documentation for parameters
  my $pp = new Business::PayPal::API::RefundTransaction ( ... );

  my %response = $pp->RefundTransaction( TransactionID => $transid,
                                         RefundType    => 'Full',
                                         Memo          => "Please come again!" );

DESCRIPTION

Business::PayPal::API::RefundTransaction implements PayPal's RefundTransaction \s-1API\s0 using SOAP::Lite to make direct \s-1API\s0 calls to PayPal's \s-1SOAP\s0 \s-1API\s0 server. It also implements support for testing via PayPal's sandbox. Please see Business::PayPal::API for details on using the PayPal sandbox.

RefundTransaction

Implements PayPal's RefundTransaction \s-1API\s0 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 \*(L"Web Services \s-1API\s0 Reference\*(R" document. The default currencyID setting is '\s-1USD\s0' 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 \s-1API\s0 indicates that the documented fields 'TransactionID', 'GrossAmount', etc. are not returned with this \s-1API\s0 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"; } }

\s-1ERROR\s0 \s-1HANDLING\s0

See the \s-1ERROR\s0 \s-1HANDLING\s0 section of Business::PayPal::API for information on handling errors.

\s-1EXPORT\s0

None by default.

RELATED TO Business::PayPal::API::RefundTransaction…

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

AUTHOR

Scot Wiersdorf <[email protected]>

COPYRIGHT AND LICENSE

Copyright (C) 2006 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.