1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
|
package Business::PayPal::API::TransactionSearch;
use 5.008001;
use strict;
use warnings;
use SOAP::Lite 0.67;
use Business::PayPal::API ();
our @ISA = qw(Business::PayPal::API);
our $VERSION = '0.11';
our $CVS_VERSION = '$Id: TransactionSearch.pm,v 1.3 2006/03/24 17:11:37 scott Exp $';
our @EXPORT_OK = qw( TransactionSearch );
sub TransactionSearch {
my $self = shift;
my %args = @_;
my %types = ( StartDate => 'xs:dateTime',
EndDate => 'xs:dateTime',
Payer => 'ebl:EmailAddressType',
Receiver => 'ebl:EmailAddressType',
ReceiptID => 'xs:string',
TransactionID => 'xs:string',
InvoiceID => 'xs:string',
PayerName => 'xs:string',
AuctionItemNumer => 'xs:string',
TransactionClass => '',
Amount => 'ebl:BasicAmountType',
CurrencyCode => 'xs:token',
Status => '',
);
my @trans =
(
$self->version_req,
SOAP::Data->name( StartDate => $args{StartDate} )->type( delete $types{StartDate} )
);
for my $type ( keys %types ) {
next unless $args{$type};
push @trans, SOAP::Data->name( $type => $args{$type} )->type($types{$type});
}
my $request = SOAP::Data->name
( TransactionSearchRequest => \SOAP::Data->value( @trans ) )
->type("ns:TransactionSearchRequestType");
my $som = $self->doCall( TransactionSearchReq => $request )
or return;
my $path = '/Envelope/Body/TransactionSearchResponse';
my %response = ();
unless( $self->getBasic($som, $path, \%response) ) {
$self->getErrors($som, $path, \%response);
return %response;
}
return $self->getFieldsList( $som, $path . '/PaymentTransactions',
{ Timestamp => 'Timestamp',
Timezone => 'Timezone',
Type => 'Type',
Payer => 'Payer',
PayerDisplayName => 'PayerDisplayName',
TransactionID => 'TransactionID',
Status => 'Status',
GrossAmount => 'GrossAmount',
FeeAmount => 'FeeAmount',
NetAmount => 'NetAmount',
} );
}
1;
__END__
=head1 NAME
Business::PayPal::API::TransactionSearch - PayPal TransactionSearch API
=head1 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, );
=head1 DESCRIPTION
B<Business::PayPal::API::TransactionSearch> implements PayPal's
B<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 I<sandbox>. Please see L<Business::PayPal::API> for details
on using the PayPal sandbox.
=head2 TransactionSearch
Implements PayPal's B<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";
}
=head2 ERROR HANDLING
See the B<ERROR HANDLING> section of B<Business::PayPal::API> for
information on handling errors.
=head2 EXPORT
None by default.
=head1 SEE ALSO
L<https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
=head1 AUTHOR
Scot Wiersdorf E<lt>scott@perlcode.orgE<gt>
=head1 COPYRIGHT AND LICENSE
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.
=cut
|