Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

business::paypal::api::capturerequest(3pm) [debian man page]

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

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

   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 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::CaptureRequest(3pm)

Check Out this Related Man Page

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

NAME

       Business::PayPal::API::RecurringPayments - PayPal RecurringPayments API

SYNOPSIS

       use Business::PayPal::API::RecurringPayments;

       my $pp = new Business::PayPal::API::RecurringPayments( ... );

       my %resp = $pp->FIXME

	 ## Ask PayPal to charge a new transaction from the ReferenceID
	 ## This method is used both for Recurring Transactions as well
	 ## as for Express Checkout's MerchantInitiatedBilling, where
	 ## ReferenceID is the BillingAgreementID returned from
	 ## ExpressCheckout->DoExpressCheckoutPayment

	 my %payinfo = $pp->DoReferenceTransaction( ReferenceID => $details{ReferenceID},
						      PaymentAction => 'Sale',
						      OrderTotal => '55.43' );

DESCRIPTION

       THIS MODULE IS NOT COMPLETE YET. PLEASE DO NOT REPORT ANY BUGS RELATED TO IT.

   DoReferenceTransaction
       Implements PayPal's WPP DoReferenceTransaction API call. Supported parameters include:

	 ReferenceID (aka BillingAgreementID)
	 PaymentAction (defaults to 'Sale' if not supplied)
	 currencyID (defaults to 'USD' if not supplied)

	 OrderTotal
	 OrderDescription
	 ItemTotal
	 ShippingTotal
	 HandlingTotal
	 TaxTotal
	 Custom
	 InvoiceID
	 ButtonSource
	 NotifyURL

	 ST_Name
	 ST_Street1
	 ST_Street2
	 ST_CityName
	 ST_StateOrProvince
	 ST_Country
	 ST_PostalCode
	 ST_Phone

	 PDI_Name
	 PDI_Description
	 PDI_Amount
	 PDI_Number
	 PDI_Quantity
	 PDI_Tax

       as described in the PayPal "Web Services API Reference" document.

       Returns a hash with the following keys:

	 BillingAgreementID
	 TransactionID
	 TransactionType
	 PaymentType
	 PaymentDate
	 GrossAmount
	 FeeAmount
	 SettleAmount
	 TaxAmount
	 ExchangeRate
	 PaymentStatus
	 PendingReason
	 ReasonCode

       Required fields:

	 ReferenceID, OrderTotal

SEE ALSO

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

AUTHOR

       Scot Wiersdorf <scott@perlcode.org>

COPYRIGHT AND LICENSE

       Copyright (C) 2007 by Scott Wiersdorf

       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::RecurringPayments(3pm)
Man Page