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

PayPal: Fully refund a capture

See more PayPal Examples

For a completed capture with no prior refunds, omit amount to request the full refund. A retry of the same refund must use its original request ID.

PayPal documentation

Chilkat PHP ActiveX Downloads

PHP ActiveX
<?php

$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 = new COM("Chilkat.Http");
$http->AuthToken = 'SANDBOX_ACCESS_TOKEN';
$resp = new COM("Chilkat.HttpResponse");

//  An empty JSON object requests a full refund. This example assumes no prior partial
//  refunds.

$http->SetUrlVar('id','CAPTURE_ID');
//  Create and persist this key once per business operation. On a timeout,
//  retry the same request with its saved key, not a newly generated one.
$crypt = new COM("Chilkat.Crypt2");
$requestId = $crypt->generateUuid();
$http->SetRequestHeader('PayPal-Request-Id',$requestId);
$http->SetRequestHeader('Prefer','return=representation');
$body = new COM("Chilkat.JsonObject");

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

if (($resp->StatusCode < 200) or ($resp->StatusCode >= 300)) {
    $errorInfo = new COM("Chilkat.JsonObject");
    $errorInfo->Load($resp->BodyStr);
    print 'HTTP ' . $resp->StatusCode . ' ' . $errorInfo->stringOf('name') . ' ' . $errorInfo->stringOf('details[0].issue') . "\n";
    print 'PayPal debug ID: ' . $errorInfo->stringOf('debug_id') . "\n";
    exit;
}

$result = new COM("Chilkat.JsonObject");
$parsed = $result->Load($resp->BodyStr);
if ($parsed != 1) {
    print 'Expected a JSON response; HTTP ' . $resp->StatusCode . "\n";
    exit;
}

print 'ID: ' . $result->stringOf('id') . "\n";
print 'Status: ' . $result->stringOf('status') . "\n";
print 'Amount: ' . $result->stringOf('amount.value') . "\n";
print 'Currency: ' . $result->stringOf('amount.currency_code') . "\n";

?>