1Business::PayPal::API::UVsoeirdRCeoqnutersitb(u3t)ed PerBlusDionceusmse:n:tPaatyiPoanl::API::VoidRequest(3)
2
3
4
6 Business::PayPal::API::VoidRequest - PayPal VoidRequest API
7
9 version 0.77
10
12 use Business::PayPal::API::VoidRequest;
13
14 # see Business::PayPal::API documentation for parameters
15 my $pp = Business::PayPal::API::VoidRequest->new( ... );
16
17 my %response = $pp->DoVoidRequest(
18 AuthorizationID => $transid Note => "Please come again!" );
19
21 Business::PayPal::API::VoidRequest implements PayPal's VoidRequest API
22 using SOAP::Lite to make direct API calls to PayPal's SOAP API server.
23 It also implements support for testing via PayPal's sandbox. Please see
24 Business::PayPal::API for details on using the PayPal sandbox.
25
26 DoVoidRequest
27 Implements PayPal's DoVoidRequest API call. Supported parameters
28 include:
29
30 AuthorizationID
31 Note
32
33 The AuthorizationID is the original ID. Not a subsequent ID from a
34 ReAuthorizationRequest. The note is a 255 character message for
35 whatever purpose you deem fit.
36
37 Returns a hash containing the results of the transaction. The Ack
38 element is likely the only useful return value at the time of this
39 revision (the Nov. 2005 errata to the Web Services API indicates that
40 the documented fields 'AuthorizationID', 'GrossAmount', etc. are not
41 returned with this API call).
42
43 Example:
44
45 my %resp = $pp->DoVoidRequest( AuthorizationID => $trans_id,
46 Note => 'Sorry about that.' );
47
48 unless( $resp{Ack} !~ /Success/ ) {
49 for my $error ( @{$response{Errors}} ) {
50 warn "Error: " . $error->{LongMessage} . "\n";
51 }
52 }
53
54 ERROR HANDLING
55 See the ERROR HANDLING section of Business::PayPal::API for information
56 on handling errors.
57
58 EXPORT
59 None by default.
60
62 <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
63
65 • Scott Wiersdorf <scott@perlcode.org>
66
67 • Danny Hembree <danny@dynamical.org>
68
69 • Bradley M. Kuhn <bkuhn@ebb.org>
70
72 This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny
73 Hembree, Bradley M. Kuhn.
74
75 This is free software; you can redistribute it and/or modify it under
76 the same terms as the Perl 5 programming language system itself.
77
78
79
80perl v5.32.1 2021-01-B2u6siness::PayPal::API::VoidRequest(3)