logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Business::PayPal::API::CaptureRequest - PayPal CaptureRequest API

Authors

       •   Scott Wiersdorf <scott@perlcode.org>

       •   Danny Hembree <danny@dynamical.org>

       •   Bradley M. Kuhn <bkuhn@ebb.org>

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";
             }
         }

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

   EXPORT
       None by default.

Name

       Business::PayPal::API::CaptureRequest - PayPal CaptureRequest API

See Also

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

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." );

Version

       version 0.77

See Also