Node.js

PayPal - Void an Authorization

See more PayPal Examples

Voids a previously authorized payment.

Note: A fully captured authorization cannot be voided.

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

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    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 chilkat.JsonObject();
    jsonToken.LoadFile("qa_data/tokens/paypal.json");

    //  Build the Authorization request header field value.
    var sbAuth = new chilkat.StringBuilder();
    //  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 chilkat.Rest();
    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..
    //  ----------------------------------------------------------------------------------------------

    var json = new chilkat.JsonObject();
    json.EmitCompact = false;

    //  This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
    rest.AddHeader("Authorization",sbAuth.GetAsString());
    rest.AddHeader("Content-Type","application/json");

    //  The authorization ID is added to the path.
    //  The authorization ID is obtained from payment records as shown here: Find Authorizations
    var sbPath = new chilkat.StringBuilder();
    sbPath.Append("/v1/payments/authorization/authorization_id/void");
    var numReplaced = sbPath.Replace("authorization_id","0SU72290A8399291G");

    //  Send the POST request containing an empty JSON body, and get the JSON response.
    var sbJsonRequest = new chilkat.StringBuilder();
    sbJsonRequest.Append("{}");

    var sbJsonResponse = new chilkat.StringBuilder();

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

    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;
    }

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

    //  A successful JSON response:

    //  	{ 
    //  	  "id": "0SU72290A8399291G",
    //  	  "create_time": "2016-11-26T17:31:05Z",
    //  	  "update_time": "2016-11-26T17:31:10Z",
    //  	  "amount": { 
    //  	    "total": "6.70",
    //  	    "currency": "USD",
    //  	    "details": { 
    //  	      "subtotal": "6.70"
    //  	    }
    //  	  },
    //  	  "state": "voided",
    //  	  "parent_payment": "PAY-62106714J93631829LA44NWI",
    //  	  "links": [
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/0SU72290A8399291G",
    //  	      "rel": "self",
    //  	      "method": "GET"
    //  	    },
    //  	    { 
    //  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-62106714J93631829LA44NWI",
    //  	      "rel": "parent_payment",
    //  	      "method": "GET"
    //  	    }
    //  	  ]
    //  	}

}

chilkatExample();