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

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.

perl v5.36.0                                       2022-08-28             Business::PayPa...curringPayments(3pm)

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

Name

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

Synopsis

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

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

           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'
           );