.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Business::PayPal::API::GetTransactionDetails 3pm"
.TH Business::PayPal::API::GetTransactionDetails 3pm "2019-11-16" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Business::PayPal::API::GetTransactionDetails \- PayPal GetTransactionDetails API
.SH "VERSION"
.IX Header "VERSION"
version 0.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Business::PayPal::API::GetTransactionDetails;
\&    my $pp = Business::PayPal::API::GetTransactionDetails\->new( ... );
.Ve
.PP
or
.PP
.Vb 3
\&    # see Business::PayPal::API documentation for parameters
\&    use Business::PayPal::API qw(GetTransactionDetails);
\&    my $pp = Business::PayPal::API\->new( ... );
\&
\&    my %response = $pp\->GetTransactionDetails( TransactionID => $transid, );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBBusiness::PayPal::API::GetTransactionDetails\fR implements PayPal's
\&\fBGetTransactionDetails\fR \s-1API\s0 using SOAP::Lite to make direct \s-1API\s0 calls to
PayPal's \s-1SOAP API\s0 server. It also implements support for testing via
PayPal's \fIsandbox\fR. Please see Business::PayPal::API for details
on using the PayPal sandbox.
.SS "GetTransactionDetails"
.IX Subsection "GetTransactionDetails"
Implements PayPal's \fBGetTransactionDetails\fR \s-1API\s0 call. Supported
parameters include:
.PP
.Vb 1
\&  TransactionID
.Ve
.PP
as described in the PayPal \*(L"Web Services \s-1API\s0 Reference\*(R" document.
.PP
Returns a hash containing the transaction details, including these fields:
.PP
.Vb 3
\&  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
.Ve
.PP
As described in the \s-1API\s0 document. Note: some fields have prefixes to
remove ambiguity for like-named fields (e.g., \*(L"\s-1PII_\*(R"\s0).
.PP
If there are multiple PaymentItems, then an additional field
\&'PaymentItems' will be available with an arrayref of PaymentItem
records:
.PP
.Vb 10
\&  PaymentItems => [ { SalesTax => ...,
\&                      Name     => \*(Aq...\*(Aq,
\&                      Number   => \*(Aq...\*(Aq,
\&                      Quantity => \*(Aq...\*(Aq,
\&                      Amount   => \*(Aq...\*(Aq,
\&                      Options  => { \*(Aqkey0\*(Aq => \*(Aqvalue0\*(Aq,
\&                                    \*(Aqkey1\*(Aq => \*(Aqvalue1\*(Aq },
\&                    },
\&                    { SalesTax => ..., etc.
\&                    } ]
.Ve
.PP
Example:
.PP
.Vb 2
\&  my %resp = $pp\->GetTransactionDetails( TransactionID => $trans_id );
\&  print "Payer: $resp{Payer}\en";
\&
\&  for my $item ( @{ $resp{PaymentItems} } ) {
\&      print "Name: " . $item\->{Name} . "\en";
\&      print "Amt: " . $item\->{Amount} . "\en";
\&      for my $optionname (keys %$item\->{Options}) {
\&          print "Option: $optionname is " . $item\->{Options}{$optionname} . "\en";
\&      }
\&  }
.Ve
.SS "PaymentItem Options Limitations"
.IX Subsection "PaymentItem Options Limitations"
Note, \s-1BTW,\s0 that PayPal has a limitation such that each PaymentItem can
contain only two Options.  See:
   <https://www.paypal.com/cgi\-bin/webscr?cmd=p/xcl/rec/options\-help\-outside>
   <https://developer.paypal.com/webapps/developer/docs/classic/paypal\-payments\-standard/integration\-guide/Appx_websitestandard_htmlvariables/>
.PP
This hack may be of interest if you want to sneak in four options:
   <https://ppmts.custhelp.com/app/answers/detail/a_id/298/kw/soap%20gettransactiondetails%20option>
.SS "\s-1ERROR HANDLING\s0"
.IX Subsection "ERROR HANDLING"
See the \fB\s-1ERROR HANDLING\s0\fR section of \fBBusiness::PayPal::API\fR for
information on handling errors.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Scott Wiersdorf <scott@perlcode.org>
.IP "\(bu" 4
Danny Hembree <danny@dynamical.org>
.IP "\(bu" 4
Bradley M. Kuhn <bkuhn@ebb.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2006\-2017 by Scott Wiersdorf, Danny Hembree, Bradley M. Kuhn.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.