debian man page for business::paypal::api::voidrequest

Business::PayPal::API::VoidRequest(3pm) 		User Contributed Perl Documentation		   Business::PayPal::API::VoidRequest(3pm)

NAME
       Business::PayPal::API::VoidRequest - PayPal VoidRequest API

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 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.

   DoVoidRequest
       Implements PayPal's DoVoidRequest API call. Supported parameters include:

	 AuthorizationID
	 Note

       The AuthorizationID is the original ID. Not a subsequent ID 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 API indicates that the documented fields 'AuthorizationID', 'GrossAmount', etc. are not
       returned with this API 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} . "
";
	     }
	 }

   ERROR HANDLING
       See the ERROR HANDLING section of Business::PayPal::API for information on handling errors.

   EXPORT
       None by default.

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

AUTHOR
       Danny Hembree <danny@dynamical.org>

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.

perl v5.14.2							    2009-12-07				   Business::PayPal::API::VoidRequest(3pm)