(PHP Extension) PayPal - Mark Invoice as Refunded

Mark an invoice as refunded.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// Note: Requires Chilkat v9.5.0.65 or greater.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
$jsonToken = new CkJsonObject();
$jsonToken->LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
$sbAuth = new CkStringBuilder();
// token_type should be "Bearer"
$sbAuth->Append($jsonToken->stringOf('token_type'));
$sbAuth->Append(' ');
$sbAuth->Append($jsonToken->stringOf('access_token'));

// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
$rest = new CkRest();
$bAutoReconnect = true;
$success = $rest->Connect('api.sandbox.paypal.com',443,true,$bAutoReconnect);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// Build the JSON request body containing the reminder information:
$json = new CkJsonObject();
$json->put_EmitCompact(false);
$dtNow = new CkDateTime();
$dtNow->SetFromCurrentSystemTime();
$sbDt = new CkStringBuilder();
$sbDt->Append($dtNow->getAsTimestamp(false));
$numReplaced = $sbDt->Replace('T',' ');
$numReplaced = $sbDt->Replace('Z',' UTC');
$json->UpdateString('date',$sbDt->getAsString());
$json->UpdateString('note','Refunded by credit card!');
$json->UpdateString('amount.currency','USD');
$json->UpdateString('amount.value','500.00');
print $json->emit() . "\n";

// The JSON created by the above code:

// 	{ 
// 	  "date": "2016-11-28 21:05:38 UTC",
// 	  "note": "Refunded by credit card!",
// 	  "amount": { 
// 	    "currency": "USD",
// 	    "value": "500.00"
// 	  }
// 	}

// Build a path using a previously-sent invoice ID.
$sbPath = new CkStringBuilder();
$sbPath->Append('/v1/invoicing/invoices/invoice_id/record-refund');
$numReplacements = $sbPath->Replace('invoice_id','INV2-QCHR-QHSD-M2VU-AVXC');

$json->put_EmitCompact(true);
$sbRequestBody = new CkStringBuilder();
$sbResponseBody = new CkStringBuilder();

$rest->AddHeader('Content-Type','application/json');
$rest->AddHeader('Authorization',$sbAuth->getAsString());
$json->EmitSb($sbRequestBody);

$success = $rest->FullRequestSb('POST',$sbPath->getAsString(),$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

print 'Response Status Code = ' . $rest->get_ResponseStatusCode() . "\n";

// Check for a success response.
if ($rest->get_ResponseStatusCode() != 204) {
    print $sbResponseBody->getAsString() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// For a success response, the response body is empty.
print 'Success.' . "\n";

?>