(Android™) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

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

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Note: Requires Chilkat v9.5.0.65 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;
    boolean success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
    if (success != true) {
        Log.i(TAG, 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());

    // To find captured payments, we list payments and look for those
    // containing a "capture" resource.
    rest.AddQueryParam("count","100");
    rest.AddQueryParam("start_index","0");
    rest.AddQueryParam("sort_by","update_time");
    rest.AddQueryParam("sort_order","asc");

    // Send the GET request and get the JSON response.
    CkStringBuilder sbJsonResponse = new CkStringBuilder();
    success = rest.FullRequestNoBodySb("GET","/v1/payments/payment",sbJsonResponse);
    if (success != true) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    CkJsonObject json = new CkJsonObject();
    json.put_EmitCompact(false);
    json.LoadSb(sbJsonResponse);

    // (optional) Save the entire JSON response to a file to examine if desired..
    CkStringBuilder sbTemp = new CkStringBuilder();
    json.EmitSb(sbTemp);
    sbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",false);

    Log.i(TAG, "Response Status Code = " + String.valueOf(rest.get_ResponseStatusCode()));

    // Did we get a 200 success response?
    if (rest.get_ResponseStatusCode() != 200) {
        Log.i(TAG, json.emit());
        Log.i(TAG, "Failed.");
        return;
        }

    // We are looking for "capture" resources .
    // As shown below, we are looking in the "transactions" for "related_resources"
    // containing "capture" JSON objects. 

    // 	{ 
    // 	  "payments": [
    // 	    { 
    // 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
    // 	      "create_time": "2016-11-24T00:33:51Z",
    // 	      "update_time": "2016-11-24T00:40:54Z",
    // 	      "state": "approved",
    // 	      "intent": "authorize",
    // 	      "payer": { 
    // 	        "payment_method": "credit_card",
    // 	        "funding_instruments": [
    // 	          { 
    // 	            ...
    // 	          }
    // 	        ]
    // 	      },
    // 	      "transactions": [
    // 	        { 
    // 	          "amount": { 
    // 	            ...
    // 	          },
    // 	          "description": "This is the payment transaction description.",
    // 	          "related_resources": [
    // 	            { 
    // 	              "authorization": { 
    // 	                ...
    // 	              }
    // 	            },
    // 	            { 
    // 	              "capture": { 
    // 	                "id": "1LY5310469661362J",
    // 	                "create_time": "2016-11-24T00:40:50Z",
    // 	                "update_time": "2016-11-24T00:40:54Z",
    // 	                "amount": { 
    // 	                  "total": "4.54",
    // 	                  "currency": "USD"
    // 	                },
    // 	                "state": "completed",
    // 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    // 	                "transaction_fee": { 
    // 	                  "value": "0.43",
    // 	                  "currency": "USD"
    // 	                },
    // 			...
    // 

    // Iterate over the payments and show each capture
    int numPayments = json.SizeOfArray("payments");
    int i = 0;
    while (i < numPayments) {
        json.put_I(i);
        int j = 0;
        int numTransactions = json.SizeOfArray("payments[i].transactions");
        while (j < numTransactions) {
            json.put_J(j);
            int numRelatedResources = json.SizeOfArray("payments[i].transactions[j].related_resources");
            int k = 0;
            while (k < numRelatedResources) {
                json.put_K(k);
                if (json.HasMember("payments[i].transactions[j].related_resources[k].capture") == true) {
                    CkJsonObject jsonCapture = json.ObjectOf("payments[i].transactions[j].related_resources[k].capture");
                    Log.i(TAG, "capture id: " + jsonCapture.stringOf("id"));
                    Log.i(TAG, "state: " + jsonCapture.stringOf("state"));
                    Log.i(TAG, "total: " + jsonCapture.stringOf("amount.total"));
                    Log.i(TAG, "----");

                    }

                k = k + 1;
                }

            j = j + 1;
            }

        i = i + 1;
        }

    Log.i(TAG, "success");

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}