table of contents
Business::PayPal::API::CaptureRequest(3pm) | User Contributed Perl Documentation | Business::PayPal::API::CaptureRequest(3pm) |
NAME¶
Business::PayPal::API::CaptureRequest - PayPal CaptureRequest API
VERSION¶
version 0.77
SYNOPSIS¶
use Business::PayPal::API::CaptureRequest; ## see Business::PayPal::API documentation for parameters my $pp = new Business::PayPal::API::DoCaptureRequest ( ... ); my %response = $pp->DoCaptureRequest( AuthorizationID => $transid, CompleteType => 'Complete', Amount => '13.00', Note => "Give the fiddler his due." );
DESCRIPTION¶
Business::PayPal::API::DoCaptureRequest implements PayPal's CaptureRequest 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.
CaptureRequest¶
Implements PayPal's CaptureRequest API call. Supported parameters include:
AuthorizationID CompleteType (defaults to 'Complete' unless set to 'NotComplete') Amount currencyID (Currently must be the default, 'USD') Note ("String, < 255 char, indicating information about the charges.")
as described in the PayPal "Web Services API Reference" document. The default currencyID setting is 'USD' if not otherwise specified. The default CompleteType setting is 'Complete' if not otherwise specified.
Returns a hash containing the results of the transaction.
Example:
my %resp = $pp->DoCaptureRequest ( AuthorizationID => $auth_id, CompleteType => 'NotComplete', Amount => '15.00', CurrencyID => 'USD', ); if( $resp{Ack} eq 'Failure' ) { for my $error ( @{$response{Errors}} ) { warn "Error: " . $error->{LongMessage} . "\n"; } }
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>
AUTHORS¶
- Scott Wiersdorf <scott@perlcode.org>
- Danny Hembree <danny@dynamical.org>
- Bradley M. Kuhn <bkuhn@ebb.org>
COPYRIGHT AND LICENSE¶
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 |