noble (3) Business::PayPal::API::TransactionSearch.3pm.gz

Provided by: libbusiness-paypal-api-perl_0.77-2_all bug

NAME
       Business::PayPal::API::TransactionSearch - PayPal TransactionSearch API


VERSION
       version 0.77


SYNOPSIS
           use Business::PayPal::API::TransactionSearch;

           # see Business::PayPal::API documentation for parameters
           my $pp = Business::PayPal::API::TransactionSearch->new( ... );

           my $transactions = $pp->TransactionSearch(
               StartDate     => '1998-01-01T00:00:00Z',
               TransactionID => $transid,
           );

           my $received = $pp->TransactionSearch(
               StartDate        => '2015-11-13T00:00:00Z',
               EndDate          => '2015-11-13T00:00:00Z',
               Status           => 'Success',
               TransactionClass => 'Received',
           );


DESCRIPTION
       Business::PayPal::API::TransactionSearch implements PayPal's TransactionSearch 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.

   TransactionSearch
       Implements PayPal's TransactionSearch API call. Supported parameters include:

         StartDate (required)
         EndDate
         Payer
         Receiver
         TransactionID
         PayerName
         AuctionItemNumber
         InvoiceID
         TransactionClass
         Amount
         CurrencyCode
         Status

       as described in the PayPal "Web Services API Reference" document. The syntax for StartDate is:

         YYYY-MM-DDTHH:MM:SSZ

       'T' and 'Z' are literal characters 'T' and 'Z' respectively, e.g.:

         2005-12-22T08:51:28Z

       Returns a list reference containing up to 100 matching records (as per the PayPal Web Services API). Each
       record is a hash reference with the following fields:

         Timestamp
         Timezone
         Type
         Payer
         PayerDisplayName
         TransactionID
         Status
         GrossAmount
         FeeAmount
         NetAmount

       Example:

           my $records = $pp->TransactionSearch(
               StartDate => '2006-03-21T22:29:55Z',
               InvoiceID => '599294993',
           );

           for my $rec ( @$records ) {
               print "Record:\n";
               print "TransactionID: " . $rec->{TransactionID} . "\n";
               print "Payer Email: " . $rec->{Payer} . "\n";
               print "Amount: " . $rec->{GrossAmount} . "\n\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>


       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.