Business::PayPal::API::CaptureRequest.3pm

Langue: en

Version: 2009-12-07 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

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

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>

AUTHOR

Danny Hembree <danny-hembree@dynamical.org> 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.