(JavaScript) PayPal - Get Sale Details

Shows details for a sale transaction, by ID.

Note: This example requires Chilkat v11.0.0 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;

// 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 == false) {
    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..
// ----------------------------------------------------------------------------------------------

// Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders();
rest.ClearAllQueryParams();

rest.AddHeader("Authorization",sbAuth.GetAsString());

// 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");
var numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J");

// Send the GET request and get the JSON response.
var sbJsonResponse = new CkStringBuilder();
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse);
if (success == false) {
    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 200 success response?
if (rest.ResponseStatusCode !== 200) {
    console.log(json.Emit());
    console.log("Failed.");
    return;
}

// Sample JSON response is shown below.
console.log(json.Emit());
console.log("----------------------");

// Show how to get a timestamp, such as update_time.
var dateTime = new CkDateTime();
success = dateTime.SetFromTimestamp(json.StringOf("update_time"));
console.log("utc update_time: " + dateTime.GetAsTimestamp(false));
console.log("local update_time: " + dateTime.GetAsTimestamp(true));
console.log("utc rfc822: " + dateTime.GetAsRfc822(false));
console.log("local rfc822: " + dateTime.GetAsRfc822(true));

var dtUtc = new CkDtObj();
dateTime.ToDtObj(false,dtUtc);

console.log(dtUtc.Month + "/" + dtUtc.Day + "/" + dtUtc.Year);

console.log("success");

// ------------------------------------------------
// A sample JSON response:

// 	{ 
// 	  "id": "1XC17935MN507400J",
// 	  "create_time": "2016-11-25T15:42:50Z",
// 	  "update_time": "2016-11-25T15:42:56Z",
// 	  "amount": { 
// 	    "total": "289.00",
// 	    "currency": "USD"
// 	  },
// 	  "payment_mode": "INSTANT_TRANSFER",
// 	  "state": "completed",
// 	  "protection_eligibility": "ELIGIBLE",
// 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
// 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// 	  "transaction_fee": { 
// 	    "value": "8.68",
// 	    "currency": "USD"
// 	  },
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
// 	      "rel": "refund",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}