Business::PayPal::API::GetTransactionDetails.3pm

Langue: en

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

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Business::PayPal::API::GetTransactionDetails - PayPal GetTransactionDetails API

SYNOPSIS

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

or

   ## see Business::PayPal::API documentation for parameters
   use Business::PayPal::API qw(GetTransactionDetails);
   my $pp = new Business::PayPal::API( ... );
 
   my %response = $pp->GetTransactionDetails( TransactionID => $transid, );

DESCRIPTION

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

GetTransactionDetails

Implements PayPal's GetTransactionDetails API call. Supported parameters include: 
   TransactionID

as described in the PayPal ``Web Services API Reference'' document.

Returns a hash containing the transaction details, including these fields:

   Business
   Receiver
   ReceiverID
 
   Payer
   PayerID
   PayerStatus
 
   Salutation
   FirstName
   MiddleName
   LastName
 
   PayerCountry
   PayerBusiness
 
   AddressOwner
   AddressStatus
   ADD_Name
   Street1
   Street2
   CityName
   StateOrProvince
   Country
   CountryName
   Phone
   PostalCode
 
   TransactionID
   ParentTransactionID
   ReceiptID
   TransactionType
   PaymentType
   PaymentDate
   GrossAmount
   FeeAmount
   SettleAmount
   TaxAmount
   ExchangeRate
   PaymentStatus
   PendingReason
   ReasonCode
 
   InvoiceID
   Custom
   Memo
   SalesTax
 
   PII_SaleTax
   PII_Name
   PII_Number
   PII_Quantity
   PII_Amount
   PII_Options
 
   PII_SubscriptionID
   PII_SubscriptionDate
   PII_EffectiveDate
   PII_RetryTime
   PII_Username
   PII_Password
   PII_Recurrences
   PII_reattempt
   PII_recurring
   PII_Amount
   PII_period
 
   PII_BuyerID
   PII_ClosingDate
   PII_multiItem

As described in the API document. Note: some fields have prefixes to remove ambiguity for like-named fields (e.g., ``PII_'').

If there are multiple PaymentItems, then an additional field 'PaymentItems' will be available with an arrayref of PaymentItem records:

   PaymentItems => [ { SalesTax => ..., 
                       Name     => '...',
                       Number   => '...',
                       Quantity => '...',
                       Amount   => '...',
                     },
                     { SalesTax => ..., etc. 
                     } ]

Example:

   my %resp = $pp->GetTransactionDetails( TransactionID => $trans_id );
   print "Payer: $resp{Payer}\n";
 
   for my $item ( @{ $resp{PaymentItems} } ) {
       print "Name: " . $item->{Name} . "\n";
       print "Amt: " . $item->{Amount} . "\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.