Sample code for 30+ languages & platforms
JavaScript Requires Chilkat v11.0.0+

PayPal: Remove an external payment recorded on the wrong invoice

See more PayPal Examples

Use the saved external payment record ID. Verify that it belongs to the selected invoice, then remove the bookkeeping entry. The bank transfer itself is unaffected. Record it on the correct invoice as a separate step.

PayPal documentation

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.
JavaScript
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();

http.SetUrlVar("id","INVOICE_ID");

success = http.HttpNoBody("GET","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}",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 paymentId = "EXTERNAL_PAYMENT_ID";
var matched = false;
var i = 0;
while ((i < result.SizeOfArray("payments.transactions"))) {
    result.I = i;
    if ((result.StringOfEquals("payments.transactions[i].payment_id",paymentId,true) == true) && (result.StringOfEquals("payments.transactions[i].type","EXTERNAL",true) == true)) {
        matched = true;
    }

    i = i+1;
}

if (matched !== true) {
    console.log("This invoice has no matching external payment record.");
    return;
}

http.SetUrlVar("paymentId",paymentId);
success = http.HttpNoBody("DELETE","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/payments/{$paymentId}",resp);
if (success !== true) {
    console.log("No HTTP response: " + http.LastErrorText);
    return;
}

if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    var removeError = new CkJsonObject();
    removeError.Load(resp.BodyStr);
    console.log("HTTP " + resp.StatusCode + " " + removeError.StringOf("name") + " " + removeError.StringOf("details[0].issue"));
    console.log("PayPal debug ID: " + removeError.StringOf("debug_id"));
    return;
}

console.log("External payment entry removed.");