(JavaScript) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// Note: Requires Chilkat v9.5.0.64 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..
// ----------------------------------------------------------------------------------------------

// To refund a particular amount, build JSON such as this:
var jsonPartial = new CkJsonObject();
jsonPartial.EmitCompact = false;
jsonPartial.UpdateString("amount.total","2.34");
jsonPartial.UpdateString("amount.currency","USD");
// invoice_number is optional..
jsonPartial.UpdateString("invoice_number","INV-1234567");
console.log(jsonPartial.Emit());

// The JSON for a partial refund:

// 	{ 
// 	  "amount": { 
// 	    "total": "2.34",
// 	    "currency": "USD"
// 	  },
// 	  "invoice_number": "INV-1234567"
// 	}

rest.AddHeader("Authorization",sbAuth.GetAsString());
rest.AddHeader("Content-Type","application/json");

// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
var sbPath = new CkStringBuilder();
sbPath.Append("/v1/payments/sale/sale_id/refund");
var numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J");

// Send the POST request containign the JSON in the request body, and get the JSON response.
var sbJsonRequest = new CkStringBuilder();
jsonPartial.EmitCompact = true;
jsonPartial.EmitSb(sbJsonRequest);
var sbJsonResponse = new CkStringBuilder();

var bFullRefund = true;
// To send a full refund, send an empty request body:
if (bFullRefund == true) {
    sbJsonRequest.Clear();
    sbJsonRequest.Append("{}");
}

success = rest.FullRequestSb("POST",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var json = new CkJsonObject();
json.EmitCompact = false;
json.LoadSb(sbJsonResponse);

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

// Did we get a 201 success response?
if (rest.ResponseStatusCode !== 201) {
    console.log(json.Emit());
    console.log("Failed.");
    return;
}

console.log(json.Emit());
console.log("Success.");

// A successful JSON response:
// The "id" is the refund_id.

// 	{ 
// 	  "id": "7NE550583A133505U",
// 	  "create_time": "2016-11-26T16:38:27Z",
// 	  "update_time": "2016-11-26T16:38:27Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "289.00",
// 	    "currency": "USD"
// 	  },
// 	  "sale_id": "1XC17935MN507400J",
// 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// 	      "rel": "sale",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}