1Business::PayPal::API::UGseetrTrCaonnstarBciutbsiuiotnneeDdsestP:ae:irPllasy(DP3oa)clu:m:eAnPtIa:t:iGoentTransactionDetails(3)
2
3
4

NAME

6       Business::PayPal::API::GetTransactionDetails - PayPal
7       GetTransactionDetails API
8

VERSION

10       version 0.77
11

SYNOPSIS

13           use Business::PayPal::API::GetTransactionDetails;
14           my $pp = Business::PayPal::API::GetTransactionDetails->new( ... );
15
16       or
17
18           # see Business::PayPal::API documentation for parameters
19           use Business::PayPal::API qw(GetTransactionDetails);
20           my $pp = Business::PayPal::API->new( ... );
21
22           my %response = $pp->GetTransactionDetails( TransactionID => $transid, );
23

DESCRIPTION

25       Business::PayPal::API::GetTransactionDetails implements PayPal's
26       GetTransactionDetails API using SOAP::Lite to make direct API calls to
27       PayPal's SOAP API server. It also implements support for testing via
28       PayPal's sandbox. Please see Business::PayPal::API for details on using
29       the PayPal sandbox.
30
31   GetTransactionDetails
32       Implements PayPal's GetTransactionDetails API call. Supported
33       parameters include:
34
35         TransactionID
36
37       as described in the PayPal "Web Services API Reference" document.
38
39       Returns a hash containing the transaction details, including these
40       fields:
41
42         Business
43         Receiver
44         ReceiverID
45
46         Payer
47         PayerID
48         PayerStatus
49
50         Salutation
51         FirstName
52         MiddleName
53         LastName
54
55         PayerCountry
56         PayerBusiness
57
58         AddressOwner
59         AddressStatus
60         ADD_Name
61         Street1
62         Street2
63         CityName
64         StateOrProvince
65         Country
66         CountryName
67         Phone
68         PostalCode
69
70         TransactionID
71         ParentTransactionID
72         ReceiptID
73         TransactionType
74         PaymentType
75         PaymentDate
76         GrossAmount
77         FeeAmount
78         SettleAmount
79         TaxAmount
80         ExchangeRate
81         PaymentStatus
82         PendingReason
83         ReasonCode
84
85         InvoiceID
86         Custom
87         Memo
88         SalesTax
89
90         PII_SaleTax
91         PII_Name
92         PII_Number
93         PII_Quantity
94         PII_Amount
95         PII_Options
96
97         PII_SubscriptionID
98         PII_SubscriptionDate
99         PII_EffectiveDate
100         PII_RetryTime
101         PII_Username
102         PII_Password
103         PII_Recurrences
104         PII_reattempt
105         PII_recurring
106         PII_Amount
107         PII_period
108
109         PII_BuyerID
110         PII_ClosingDate
111         PII_multiItem
112
113       As described in the API document. Note: some fields have prefixes to
114       remove ambiguity for like-named fields (e.g., "PII_").
115
116       If there are multiple PaymentItems, then an additional field
117       'PaymentItems' will be available with an arrayref of PaymentItem
118       records:
119
120         PaymentItems => [ { SalesTax => ...,
121                             Name     => '...',
122                             Number   => '...',
123                             Quantity => '...',
124                             Amount   => '...',
125                             Options  => { 'key0' => 'value0',
126                                           'key1' => 'value1' },
127                           },
128                           { SalesTax => ..., etc.
129                           } ]
130
131       Example:
132
133         my %resp = $pp->GetTransactionDetails( TransactionID => $trans_id );
134         print "Payer: $resp{Payer}\n";
135
136         for my $item ( @{ $resp{PaymentItems} } ) {
137             print "Name: " . $item->{Name} . "\n";
138             print "Amt: " . $item->{Amount} . "\n";
139             for my $optionname (keys %$item->{Options}) {
140                 print "Option: $optionname is " . $item->{Options}{$optionname} . "\n";
141             }
142         }
143
144   PaymentItem Options Limitations
145       Note, BTW, that PayPal has a limitation such that each PaymentItem can
146       contain only two Options.  See:
147          <https://www.paypal.com/cgi-bin/webscr?cmd=p/xcl/rec/options-help-outside>
148          <https://developer.paypal.com/webapps/developer/docs/classic/paypal-payments-standard/integration-guide/Appx_websitestandard_htmlvariables/>
149
150       This hack may be of interest if you want to sneak in four options:
151          <https://ppmts.custhelp.com/app/answers/detail/a_id/298/kw/soap%20gettransactiondetails%20option>
152
153   ERROR HANDLING
154       See the ERROR HANDLING section of Business::PayPal::API for information
155       on handling errors.
156
157   EXPORT
158       None by default.
159

SEE ALSO

161       <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
162

AUTHORS

164       ·   Scott Wiersdorf <scott@perlcode.org>
165
166       ·   Danny Hembree <danny@dynamical.org>
167
168       ·   Bradley M. Kuhn <bkuhn@ebb.org>
169
171       This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny
172       Hembree, Bradley M. Kuhn.
173
174       This is free software; you can redistribute it and/or modify it under
175       the same terms as the Perl 5 programming language system itself.
176
177
178
179perl v5.28.1                   Bus2i0n1e7s-s1:1:-P1a3yPal::API::GetTransactionDetails(3)
Impressum