NAME

WWW::PayPal::Capture - PayPal Payments v2 capture entity

VERSION

version 0.002

SYNOPSIS

my $capture = $pp->payments->get_capture($capture_id);

print $capture->id,          "\n";
print $capture->status,      "\n";
print $capture->amount,      "\n";
print $capture->currency,    "\n";
print $capture->fee_in_cent, "\n";

my $refund = $capture->refund(
    amount => { currency_code => 'EUR', value => '5.00' },
);

DESCRIPTION

Wrapper around a PayPal capture JSON object. Captures are what you get back from "capture" in WWW::PayPal::API::Orders (attached to the order) and from "get_capture" in WWW::PayPal::API::Payments.

data

Raw decoded JSON for the capture.

id

Capture ID (use this with "refund" in WWW::PayPal::API::Payments).

status

Capture status — COMPLETED, PENDING, DECLINED, REFUNDED, PARTIALLY_REFUNDED, FAILED.

amount

String amount of the capture, e.g. "42.00".

currency

Currency code, e.g. "EUR".

invoice_id

Merchant invoice ID, if one was set when creating the order.

fee_in_cent

PayPal's fee for this capture, in cents (rounded from the decimal string PayPal returns).

refund

my $refund = $capture->refund(
    amount         => { currency_code => 'EUR', value => '5.00' },
    note_to_payer  => 'Partial refund',
);

Issues a refund against this capture. Omit amount for a full refund. Returns a WWW::PayPal::Refund.

SEE ALSO

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-www-paypal/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.