Busine...equest(3pm)

💖 Business::PayPal::API::VoidRequest — the manual, but make it cute 💖

okay bestie, gather round, because this is Busine...equest(3pm) from the User Contributed Perl Documentation, and it's literally the PayPal VoidRequest API wrapper. No cap. Let's get into it. 🫶

---

✨ NAME ✨

Business::PayPal::API::VoidRequest — it's the PayPal VoidRequest API, and it's living in the Business::PayPal::API family. That's it, that's the name, slay. 💅

---

🌸 VERSION 🌸

version 0.77 — yes, she's vintage, she's iconic, she's been around. 👑

---

🦋 SYNOPSIS 🦋

okay so here's the whole vibe, verbatim, don't touch a character:

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!" );

literally that's it. you load the module, you build your object (and bestie, the params are all documented over in Business::PayPal::API, go look), then you call DoVoidRequest. easy. ✨

---

💜 DESCRIPTION 💜

So Business::PayPal::API::VoidRequest implements PayPal's VoidRequest API, and it does it by using SOAP::Lite to make direct API calls to PayPal's SOAP API server. Direct. No middleman. Main character energy fr fr.

It also implements support for testing via PayPal's sandbox — so you can play around without setting real money on fire. 🙈 For the deets on using the PayPal sandbox, please see Business::PayPal::API. 🎀

💫 DoVoidRequest 💫

This is the one that does the thing: it implements PayPal's DoVoidRequest API call. The supported parameters include:

AuthorizationID
Note

The AuthorizationID is the original ID. Not a subsequent ID from a ReAuthorizationRequest. Like, the original original. Don't come in here with some re-auth ID and expect it to work, that's not the assignment. And the Note is a 255 character message for whatever purpose you deem fit — vent, send love, write a haiku, your call. 🌈

It returns a hash containing the results of the transaction. The Ack element is likely the only useful return value at the time of this revision — and the reason is literally spelled out: the Nov. 2005 errata to the Web Services API indicates that the documented fields 'AuthorizationID', 'GrossAmount', etc. are not returned with this API call. so like, don't go looking for them, they're not coming. 💀

Example time:

my %resp = $pp->DoVoidRequest( AuthorizationID => $trans_id,
                               Note            => 'Sorry about that.' );

unless( $resp{Ack} !~ /Success/ ) {
    for my $error ( @{$response{Errors}} ) {
        warn "Error: " . $error->{LongMessage} . "\n";
    }
}

🚨 ERROR HANDLING 🚨

Errors? Handled. Just go read the ERROR HANDLING section of Business::PayPal::API for the info on handling errors. That's where the lore lives. 📖

🎀 EXPORT 🎀

None by default. Nothing gets exported unless you ask. She's low maintenance like that. 💅

---

🔥 SEE ALSO 🔥

• <https://developer.paypal.com/en_US/pdf/PP_APIReference.pdf> — the sacred text, go read it, iykyk 📜

---

👑 AUTHORS 👑

The legends who made this happen:

• Scott Wiersdorf <scott@perlcode.org>
• Danny Hembree <danny@dynamical.org>
• Bradley M. Kuhn <bkuhn@ebb.org>

three icons, one module. we stan. 🫶

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2006-2017 by Scott Wiersdorf, Danny Hembree, Bradley M. Kuhn.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so like, go wild, but respectfully. ✨

---

fr fr, that's the whole page. every flag, every field, every warning — nothing skipped, nothing invented. 💖

okay bestie that's a wrap!! this page ships with perl v5.36.0 and it's dated 2022-08-28 — and yes, that is the same timestamp for the header and the footer, iconic consistency. bye pookie, go void some transactions responsibly 🦋💅🎀