SYNOPSIS

  use Business::PayPal::API::VoidRequest;

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

  my %response = $pp->DoVoidRequest( AuthorizationID => $transid
                                     Note            => "Please come again!" );

DESCRIPTION

Business::PayPal::API::VoidRequest implements PayPal's VoidRequest \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.

DoVoidRequest

Implements PayPal's DoVoidRequest \s-1API\s0 call. Supported parameters include:

AuthorizationID Note

The AuthorizationID is the original \s-1ID\s0. Not a subsequent \s-1ID\s0 from a ReAuthorizationRequest. The note is a 255 character message for whatever purpose you deem fit.

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 'AuthorizationID', 'GrossAmount', etc. are not returned with this \s-1API\s0 call).

Example:

my %resp = $pp->DoVoidRequest( AuthorizationID => $trans_id, Note => 'Sorry about that.' );

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::VoidRequest…

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

AUTHOR

Danny Hembree <[email protected]>

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Danny Hembree

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.