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
|
package Business::PayPal::API::CaptureRequest;
use 5.008001;
use strict;
use warnings;
use SOAP::Lite 0.67;
#use SOAP::Lite +trace => 'debug';
use Business::PayPal::API ();
our @ISA = qw(Business::PayPal::API);
our $VERSION = '0.11';
our $CVS_VERSION = '$Id: CaptureRequest.pm,v 1.2 2007/10/16 19:09:26 scott Exp $';
our @EXPORT_OK = qw(DoCaptureRequest);
sub DoCaptureRequest {
my $self = shift;
my %args = @_;
my %types = (
AuthorizationID => 'xs:string',
#The inclusion of the "ebl:CompleteCodeType" here, or any other reasonable type,
#causes and error. Assigning a null string allows the module to work normally
#with the exception that testing for "Success" fails, one must test for not
#being a "Failure"... there may be a life lesson here.
CompleteType => '',
Amount => 'ebl:BasicAmountType',
Note => 'xs:string',
);
$args{currencyID} ||= 'USD';
$args{CompleteType} ||= 'Complete';
my @ref_trans =
(
$self->version_req,
SOAP::Data->name( AuthorizationID => $args{AuthorizationID} )->type($types{AuthorizationID}),
SOAP::Data->name( CompleteType => $args{CompleteType} )->type($types{CompleteType}),
);
if( $args{Amount} ) {
push @ref_trans,
SOAP::Data->name( Amount => $args{Amount} )
->type( $types{Amount} )
->attr( { currencyID => $args{currencyID} } )
}
my $request = SOAP::Data->name
( DoCaptureRequest => \SOAP::Data->value( @ref_trans ) )
->type("ns:DoCaptureRequestType");
my $som = $self->doCall( DoCaptureReq => $request )
or return;
my $path = '/Envelope/Body/DoCaptureResponse';
my %response = ();
unless( $self->getBasic($som, $path, \%response) ) {
$self->getErrors($som, $path, \%response);
return %response;
}
$path .= '/DoCaptureResponseDetails/PaymentInfo';
$self->getFields($som, $path, \%response,
{
TransactionID => 'TransactionID',
ParentTransactionID => 'ParentTransactionID',
ReceiptID => 'ReceiptID',
TransactionType => 'TransactionType',
PaymentType => 'PaymentType',
PaymentDate => 'PaymentDate',
GrossAmount => 'GrossAmount',
FeeAmount => 'FeeAmount',
SettleAmount => 'SettleAmount',
TaxAmount => 'TaxAmount',
ExchangeRate => 'ExchangeRate',
PaymentStatus => 'PaymentStatus',
PendingReason => 'PendingReason',
ReasonCode => 'ReasonCode',
}
);
return %response;
}
1;
__END__
=head1 NAME
Business::PayPal::API::CaptureRequest - PayPal CaptureRequest API
=head1 SYNOPSIS
use Business::PayPal::API::CaptureRequest;
## see Business::PayPal::API documentation for parameters
my $pp = new Business::PayPal::API::DoCaptureRequest ( ... );
my %response = $pp->DoCaptureRequest( AuthorizationID => $transid,
CompleteType => 'Complete',
Amount => '13.00',
Note => "Give the fiddler his due." );
=head1 DESCRIPTION
B<Business::PayPal::API::DoCaptureRequest> implements PayPal's
B<CaptureRequest> 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 CaptureRequest
Implements PayPal's B<CaptureRequest> API call. Supported
parameters include:
AuthorizationID
CompleteType (defaults to 'Complete' unless set to 'NotComplete')
Amount
currencyID (Currently must be the default, 'USD')
Note ("String, < 255 char, indicating information about the charges.")
as described in the PayPal "Web Services API Reference" document. The
default B<currencyID> setting is 'USD' if not otherwise specified. The
default B<CompleteType> setting is 'Complete' if not otherwise specified.
Returns a hash containing the results of the transaction.
Example:
my %resp = $pp->DoCaptureRequest (
AuthorizationID => $auth_id,
CompleteType => 'NotComplete',
Amount => '15.00',
CurrencyID => 'USD',
);
if( $resp{Ack} eq 'Failure' ) {
for my $error ( @{$response{Errors}} ) {
warn "Error: " . $error->{LongMessage} . "\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
Danny Hembree E<lt>danny-hembree@dynamical.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2006 by Danny Hembree
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
|
