.\" 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::CaptureRequest 3pm"
.TH Business::PayPal::API::CaptureRequest 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::CaptureRequest \- PayPal CaptureRequest API
.SH "VERSION"
.IX Header "VERSION"
version 0.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  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    => \*(AqComplete\*(Aq,
\&                                        Amount          => \*(Aq13.00\*(Aq,
\&                                        Note            => "Give the fiddler his due." );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBBusiness::PayPal::API::DoCaptureRequest\fR implements PayPal's
\&\fBCaptureRequest\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 "CaptureRequest"
.IX Subsection "CaptureRequest"
Implements PayPal's \fBCaptureRequest\fR \s-1API\s0 call. Supported
parameters include:
.PP
.Vb 5
\&  AuthorizationID
\&  CompleteType (defaults to \*(AqComplete\*(Aq unless set to \*(AqNotComplete\*(Aq)
\&  Amount
\&  currencyID (Currently must be the default, \*(AqUSD\*(Aq)
\&  Note ("String, < 255 char, indicating information about the charges.")
.Ve
.PP
as described in the PayPal \*(L"Web Services \s-1API\s0 Reference\*(R" document. The
default \fBcurrencyID\fR setting is '\s-1USD\s0' if not otherwise specified. The
default \fBCompleteType\fR setting is 'Complete' if not otherwise specified.
.PP
Returns a hash containing the results of the transaction.
.PP
Example:
.PP
.Vb 6
\&  my %resp = $pp\->DoCaptureRequest (
\&                                     AuthorizationID => $auth_id,
\&                                     CompleteType    => \*(AqNotComplete\*(Aq,
\&                                     Amount          => \*(Aq15.00\*(Aq,
\&                                     CurrencyID     => \*(AqUSD\*(Aq,
\&                                    );
\&
\&  if( $resp{Ack} eq \*(AqFailure\*(Aq ) {
\&      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.