Business::PayPal::API::TransactionSearch.3pm

Langue: en

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

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

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

SYNOPSIS

   use Business::PayPal::API::TransactionSearch;
 
   ## see Business::PayPal::API documentation for parameters
   my $pp = new Business::PayPal::API::TransactionSearch ( ... );
 
   my %response = $pp->TransactionSearch( StartDate => '1998-01-01T00:00:00Z',
                                          TransactionID => $transid, );

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>

AUTHOR

Scot Wiersdorf <scott@perlcode.org> Copyright (C) 2006 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.