.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Business::PayPal::API::VoidRequest 3pm"
.TH Business::PayPal::API::VoidRequest 3pm "2019-11-16" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Business::PayPal::API::VoidRequest \- PayPal VoidRequest API
.SH "VERSION"
.IX Header "VERSION"
version 0.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Business::PayPal::API::VoidRequest;
\&
\&    # see Business::PayPal::API documentation for parameters
\&    my $pp = Business::PayPal::API::VoidRequest\->new( ... );
\&
\&    my %response = $pp\->DoVoidRequest(
\&        AuthorizationID => $transid Note => "Please come again!" );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBBusiness::PayPal::API::VoidRequest\fR implements PayPal's
\&\fBVoidRequest\fR \s-1API\s0 using SOAP::Lite to make direct \s-1API\s0 calls to
PayPal's \s-1SOAP API\s0 server. It also implements support for testing via
PayPal's \fIsandbox\fR. Please see Business::PayPal::API for details
on using the PayPal sandbox.
.SS "DoVoidRequest"
.IX Subsection "DoVoidRequest"
Implements PayPal's \fBDoVoidRequest\fR \s-1API\s0 call. Supported
parameters include:
.PP
.Vb 2
\&  AuthorizationID
\&  Note
.Ve
.PP
The \fBAuthorizationID\fR is the original \s-1ID.\s0 Not a subsequent \s-1ID\s0 from a
\&\fBReAuthorizationRequest\fR. The note is a 255 character message for
whatever purpose you deem fit.
.PP
Returns a hash containing the results of the transaction. The \fBAck\fR
element is likely the only useful return value at the time of this
revision (the Nov. 2005 errata to the Web Services \s-1API\s0 indicates that
the documented fields 'AuthorizationID', 'GrossAmount', etc. are \fInot\fR
returned with this \s-1API\s0 call).
.PP
Example:
.PP
.Vb 2
\&  my %resp = $pp\->DoVoidRequest( AuthorizationID => $trans_id,
\&                                 Note            => \*(AqSorry about that.\*(Aq );
\&
\&  unless( $resp{Ack} !~ /Success/ ) {
\&      for my $error ( @{$response{Errors}} ) {
\&          warn "Error: " . $error\->{LongMessage} . "\en";
\&      }
\&  }
.Ve
.SS "\s-1ERROR HANDLING\s0"
.IX Subsection "ERROR HANDLING"
See the \fB\s-1ERROR HANDLING\s0\fR section of \fBBusiness::PayPal::API\fR for
information on handling errors.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf>
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Scott Wiersdorf <scott@perlcode.org>
.IP "\(bu" 4
Danny Hembree <danny@dynamical.org>
.IP "\(bu" 4
Bradley M. Kuhn <bkuhn@ebb.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2006\-2017 by Scott Wiersdorf, Danny Hembree, Bradley M. Kuhn.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.