PayPal - Mark Invoice as Refunded

See more PayPal Examples

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

var success = false;

// 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)
var jsonToken = new CkJsonObject();
jsonToken.LoadFile("qa_data/tokens/paypal.json");

// Build the Authorization request header field value.
var 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.
var rest = new CkRest();
var bAutoReconnect = true;
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// 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:
var json = new CkJsonObject();
json.EmitCompact = false;
var dtNow = new CkDateTime();
dtNow.SetFromCurrentSystemTime();
var sbDt = new CkStringBuilder();
sbDt.Append(dtNow.GetAsTimestamp(false));
var 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");
console.log(json.Emit());

// 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.
var sbPath = new CkStringBuilder();
sbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund");
var numReplacements = sbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC");

json.EmitCompact = true;
var sbRequestBody = new CkStringBuilder();
var 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) {
    console.log(rest.LastErrorText);
    return;
}

console.log("Response Status Code = " + rest.ResponseStatusCode);

// Check for a success response.
if (rest.ResponseStatusCode !== 204) {
    console.log(sbResponseBody.GetAsString());
    console.log("Failed.");
    return;
}

// For a success response, the response body is empty.
console.log("Success.");