1Business::PayPal::API::UCsaeprtuCroenRterqiubeustte(d3B)PuesrilneDsosc:u:mPeanytPaatli:o:nAPI::CaptureRequest(3)
2
3
4
6 Business::PayPal::API::CaptureRequest - PayPal CaptureRequest API
7
9 version 0.77
10
12 use Business::PayPal::API::CaptureRequest;
13
14 ## see Business::PayPal::API documentation for parameters
15 my $pp = new Business::PayPal::API::DoCaptureRequest ( ... );
16
17 my %response = $pp->DoCaptureRequest( AuthorizationID => $transid,
18 CompleteType => 'Complete',
19 Amount => '13.00',
20 Note => "Give the fiddler his due." );
21
23 Business::PayPal::API::DoCaptureRequest implements PayPal's
24 CaptureRequest API using SOAP::Lite to make direct API calls to
25 PayPal's SOAP API server. It also implements support for testing via
26 PayPal's sandbox. Please see Business::PayPal::API for details on using
27 the PayPal sandbox.
28
29 CaptureRequest
30 Implements PayPal's CaptureRequest API call. Supported parameters
31 include:
32
33 AuthorizationID
34 CompleteType (defaults to 'Complete' unless set to 'NotComplete')
35 Amount
36 currencyID (Currently must be the default, 'USD')
37 Note ("String, < 255 char, indicating information about the charges.")
38
39 as described in the PayPal "Web Services API Reference" document. The
40 default currencyID setting is 'USD' if not otherwise specified. The
41 default CompleteType setting is 'Complete' if not otherwise specified.
42
43 Returns a hash containing the results of the transaction.
44
45 Example:
46
47 my %resp = $pp->DoCaptureRequest (
48 AuthorizationID => $auth_id,
49 CompleteType => 'NotComplete',
50 Amount => '15.00',
51 CurrencyID => 'USD',
52 );
53
54 if( $resp{Ack} eq 'Failure' ) {
55 for my $error ( @{$response{Errors}} ) {
56 warn "Error: " . $error->{LongMessage} . "\n";
57 }
58 }
59
60 ERROR HANDLING
61 See the ERROR HANDLING section of Business::PayPal::API for information
62 on handling errors.
63
64 EXPORT
65 None by default.
66
68 <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
69
71 • Scott Wiersdorf <scott@perlcode.org>
72
73 • Danny Hembree <danny@dynamical.org>
74
75 • Bradley M. Kuhn <bkuhn@ebb.org>
76
78 This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny
79 Hembree, Bradley M. Kuhn.
80
81 This is free software; you can redistribute it and/or modify it under
82 the same terms as the Perl 5 programming language system itself.
83
84
85
86perl v5.34.0 2022-B0u1s-i2n0ess::PayPal::API::CaptureRequest(3)