JavaScript Requires Chilkat v11.0.0+
JavaScript
PayPal: Export a day of balance activity to CSV
See more PayPal Examples
Create a UTF-8 ledger export for the previous UTC day. Preserve signed amounts and separate currencies, and leave absent fees blank. The file is written after all pages have been read. Transaction Search can lag by several hours.
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;
// 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.
var http = new CkHttp();
http.AuthToken = "SANDBOX_ACCESS_TOKEN";
var resp = new CkHttpResponse();
// Export yesterday in UTC; choose an earlier date if the report is still refreshing.
var day = new CkDateTime();
day.SetFromCurrentSystemTime();
day.AddDays(-1);
var utcDate = day.GetAsIso8601("YYYY-MM-DD",false);
var startTime = new CkStringBuilder();
startTime.Append(utcDate);
startTime.Append("T00:00:00Z");
var endTime = new CkStringBuilder();
endTime.Append(utcDate);
endTime.Append("T23:59:59.999Z");
var query = new CkJsonObject();
query.UpdateString("start_date",startTime.GetAsString());
query.UpdateString("end_date",endTime.GetAsString());
query.UpdateString("balance_affecting_records_only","Y");
query.UpdateString("fields","transaction_info");
query.UpdateInt("page_size",100);
var csv = new CkCsv();
csv.HasColumnNames = true;
csv.SetColumnName(0,"transaction_id");
csv.SetColumnName(1,"event_code");
csv.SetColumnName(2,"status");
csv.SetColumnName(3,"currency");
csv.SetColumnName(4,"amount");
csv.SetColumnName(5,"fee_currency");
csv.SetColumnName(6,"fee");
var row = 0;
var page = 1;
var lastPage = 1;
while ((page <= lastPage)) {
query.UpdateInt("page",page);
success = http.HttpParams("GET","https://api-m.sandbox.paypal.com/v1/reporting/transactions",query,resp);
if (success !== true) {
console.log("No HTTP response: " + http.LastErrorText);
return;
}
if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
var errorInfo = new CkJsonObject();
errorInfo.Load(resp.BodyStr);
console.log("HTTP " + resp.StatusCode + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"));
console.log("PayPal debug ID: " + errorInfo.StringOf("debug_id"));
return;
}
var result = new CkJsonObject();
var parsedResult = result.Load(resp.BodyStr);
if (parsedResult !== true) {
console.log("Expected a JSON response; HTTP " + resp.StatusCode);
return;
}
var i = 0;
var count = result.SizeOfArray("transaction_details");
while ((i < count)) {
result.I = i;
csv.SetCell(row,0,result.StringOf("transaction_details[i].transaction_info.transaction_id"));
csv.SetCell(row,1,result.StringOf("transaction_details[i].transaction_info.transaction_event_code"));
csv.SetCell(row,2,result.StringOf("transaction_details[i].transaction_info.transaction_status"));
csv.SetCell(row,3,result.StringOf("transaction_details[i].transaction_info.transaction_amount.currency_code"));
csv.SetCell(row,4,result.StringOf("transaction_details[i].transaction_info.transaction_amount.value"));
csv.SetCell(row,5,result.StringOf("transaction_details[i].transaction_info.fee_amount.currency_code"));
csv.SetCell(row,6,result.StringOf("transaction_details[i].transaction_info.fee_amount.value"));
row = row+1;
i = i+1;
}
lastPage = result.IntOf("total_pages");
page = page+1;
}
var filename = new CkStringBuilder();
filename.Append("paypal-activity-");
filename.Append(utcDate);
filename.Append(".csv");
var saved = csv.SaveFile2(filename.GetAsString(),"utf-8");
if (saved !== true) {
console.log(csv.LastErrorText);
return;
}
console.log("Exported " + row + " rows to " + filename.GetAsString());