Java

PayPal - Capture Authorization

See more PayPal Examples

Capture and process a previously created authorization. The original payment call must have the intent set to authorize.

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

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean 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)
    CkJsonObject jsonToken = new CkJsonObject();
    jsonToken.LoadFile("qa_data/tokens/paypal.json");

    // Build the Authorization request header field value.
    CkStringBuilder 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.
    CkRest rest = new CkRest();
    boolean bAutoReconnect = true;
    success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
    if (success != true) {
        System.out.println(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 capture a particular amount, build JSON such as this:
    CkJsonObject json = new CkJsonObject();
    json.put_EmitCompact(false);
    json.UpdateString("amount.currency","USD");
    json.UpdateString("amount.total","6.70");
    // is_final_capture is optional and indicates whether to release all remaining funds that the authorization holds in the funding instrument.
    json.UpdateBool("is_final_capture",true);
    System.out.println(json.emit());

    // The JSON created by the above code:

    // 	{ 
    // 	  "amount": { 
    // 	    "currency": "USD",
    // 	    "total": "6.70"
    // 	  },
    // 	  "is_final_capture": true
    // 	}

    // 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
    CkStringBuilder sbPath = new CkStringBuilder();
    sbPath.Append("/v1/payments/authorization/authorization_id/capture");
    int numReplaced = sbPath.Replace("authorization_id","6HG91590AX913463C");

    // Send the POST request containing the JSON in the request body, and get the JSON response.
    CkStringBuilder sbJsonRequest = new CkStringBuilder();
    json.put_EmitCompact(true);
    json.EmitSb(sbJsonRequest);
    CkStringBuilder sbJsonResponse = new CkStringBuilder();

    success = rest.FullRequestSb("POST",sbPath.getAsString(),sbJsonRequest,sbJsonResponse);
    if (success != true) {
        System.out.println(rest.lastErrorText());
        return;
        }

    json.put_EmitCompact(false);
    json.LoadSb(sbJsonResponse);

    System.out.println("Response Status Code = " + rest.get_ResponseStatusCode());

    // Did we get a 200 success response?
    if (rest.get_ResponseStatusCode() != 200) {
        System.out.println(json.emit());
        System.out.println("Failed.");
        return;
        }

    System.out.println(json.emit());
    System.out.println("Success.");

    // A successful JSON response:

    // 	{ 
    // 	  "id": "87S70321AE222860G",
    // 	  "create_time": "2016-11-26T17:27:46Z",
    // 	  "update_time": "2016-11-26T17:27:50Z",
    // 	  "amount": { 
    // 	    "total": "6.70",
    // 	    "currency": "USD"
    // 	  },
    // 	  "is_final_capture": true,
    // 	  "state": "completed",
    // 	  "reasonCode": "None",
    // 	  "parent_payment": "PAY-3SL8976592063093RLA3DMAY",
    // 	  "transaction_fee": { 
    // 	    "value": "0.49",
    // 	    "currency": "USD"
    // 	  },
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G/refund",
    // 	      "rel": "refund",
    // 	      "method": "POST"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C",
    // 	      "rel": "authorization",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-3SL8976592063093RLA3DMAY",
    // 	      "rel": "parent_payment",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}
    // 
  }
}