Sample code for 30+ languages & platforms
CkPerl Requires Chilkat v11.0.0+

PayPal: Record an external refund against an invoice

See more PayPal Examples

Record USD 5 already returned by bank transfer for a paid invoice. This call does not move money. To refund a PayPal capture, use the Payments v2 capture refund example instead.

PayPal documentation

Chilkat CkPerl Downloads

CkPerl
use chilkat();

$success = 0;

#  See Unlock Chilkat before making requests.
#  For the merchant's internal backoffice application. Load the sandbox token
#  from the merchant's credential store. Keep it out of publicly distributed apps.
#  See Get a PayPal access token.
$http = chilkat::CkHttp->new();
$http->put_AuthToken("SANDBOX_ACCESS_TOKEN");
$resp = chilkat::CkHttpResponse->new();

#  Record only money already returned outside PayPal. Reconcile first if a previous
#  attempt timed out.

$http->SetUrlVar("id","INVOICE_ID");
$body = chilkat::CkJsonObject->new();
$body->UpdateString("method","BANK_TRANSFER");
$body->UpdateString("amount.currency_code","USD");
$body->UpdateString("amount.value","5.00");

#  Use the actual date of the transfer; this example records one made today.
$date = chilkat::CkDateTime->new();
$date->SetFromCurrentSystemTime();
$body->UpdateString("refund_date",$date->getAsIso8601("YYYY-MM-DD",0));

$success = $http->HttpJson("POST","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/refunds",$body,"application/json",$resp);
if ($success != 1) {
    print "No HTTP response: " . $http->lastErrorText() . "\r\n";
    exit;
}

if (($resp->get_StatusCode() < 200) or ($resp->get_StatusCode() >= 300)) {
    $errorInfo = chilkat::CkJsonObject->new();
    $errorInfo->Load($resp->bodyStr());
    print "HTTP " . $resp->get_StatusCode() . " " . $errorInfo->stringOf("name") . " " . $errorInfo->stringOf("details[0].issue") . "\r\n";
    print "PayPal debug ID: " . $errorInfo->stringOf("debug_id") . "\r\n";
    exit;
}

$result = chilkat::CkJsonObject->new();
$parsed = $result->Load($resp->bodyStr());
if ($parsed != 1) {
    print "Expected a JSON response; HTTP " . $resp->get_StatusCode() . "\r\n";
    exit;
}

print "Record ID: " . $result->stringOf("refund_id") . "\r\n";