Dart Requires Chilkat v11.0.0+

PayPal - Find Completed Sales

See more PayPal Examples

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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)
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/paypal.json');

  // Build the Authorization request header field value.
  final sbAuth = 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.
  final rest = CkRest();
  final bAutoReconnect = true;
  try {
    rest.connect('api.sandbox.paypal.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.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 sales transactions, we list payments and look for those
  // containing "sale" transactions
  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.
  final sbJsonResponse = CkStringBuilder();
  try {
    rest.fullRequestNoBodySb('GET', '/v1/payments/payment', sbJsonResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final json = CkJsonObject();
  json.emitCompact = false;
  json.loadSb(sbJsonResponse);

  // (optional) Save the entire JSON response to a file to examine if desired..
  final sbTemp = CkStringBuilder();
  json.emitSb(sbTemp);
  sbTemp.writeFile('qa_output/paypal_payments.json', 'utf-8', false);

  print('Response Status Code = ${rest.responseStatusCode}');

  // Did we get a 200 success response?
  if (rest.responseStatusCode != 200) {
    print(json.emit());
    print('Failed.');
    return;
  }

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

  // 	{ 
  // 	  "payments": [
  // 	    { 
  // 	      "id": "PAY-66A12106PU3254228LA3BYKI",
  // 	      "create_time": "2016-11-23T22:46:01Z",
  // 	      "update_time": "2016-11-23T22:46:07Z",
  // 	      "state": "approved",
  // 	      "intent": "sale",
  // 	      "payer": { 
  // 	          ...
  // 	          }
  // 	        ]
  // 	      },
  // 	      "transactions": [
  // 	        { 
  // 	          ...
  // 	          "related_resources": [
  // 	            { 
  // 	              "sale": { 
  // 	                "id": "70L88278E6781074B",
  // 	                "create_time": "2016-11-23T22:46:01Z",
  // 	                "update_time": "2016-11-23T22:46:07Z",
  // 	                "amount": { 
  // 	                  "total": "7.47",
  // 	                  "currency": "USD"
  // 	                },
  // 	                "state": "completed",
  // 	                "parent_payment": "PAY-66A12106PU3254228LA3BYKI",

  // Iterate over the payments and show each sale transaction.
  final jsonSale = CkJsonObject();
  final numPayments = json.sizeOfArray('payments');
  var i = 0;
  while (i < numPayments) {

    json.i = i;
    var j = 0;
    final numTransactions = json.sizeOfArray('payments[i].transactions');
    while (j < numTransactions) {
      json.j = j;
      final numRelatedResources = json.sizeOfArray('payments[i].transactions[j].related_resources');
      var k = 0;
      while (k < numRelatedResources) {
        json.k = k;
        if (json.hasMember('payments[i].transactions[j].related_resources[k].sale')) {

          json.objectOf2('payments[i].transactions[j].related_resources[k].sale', jsonSale);

          print('sale id: ${jsonSale.stringOf('id')}');
          print('state: ${jsonSale.stringOf('state')}');
          print('total: ${jsonSale.stringOf('amount.total')}');
          print('----');
        }

        k++;
      }

      j++;
    }

    i++;
  }

  print('success');
}