Dart Requires Chilkat v11.0.0+

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. 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());

  // The sale ID is added to the path.
  // The sale ID is obtained from payment records as shown here: Find Completed Sales
  final sbPath = CkStringBuilder();
  sbPath.append('/v1/payments/sale/sale_id');
  final numReplaced = sbPath.replace('sale_id', '1XC17935MN507400J');

  // Send the GET request and get the JSON response.
  final sbJsonResponse = CkStringBuilder();
  try {
    rest.fullRequestNoBodySb('GET', sbPath.getAsString(), sbJsonResponse);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

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

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

  // Sample JSON response is shown below.
  print(json.emit());
  print('----------------------');

  // Show how to get a timestamp, such as update_time.
  final dateTime = CkDateTime();
  dateTime.setFromTimestamp(json.stringOf('update_time'));
  print('utc update_time: ${dateTime.getAsTimestamp(false)}');
  print('local update_time: ${dateTime.getAsTimestamp(true)}');
  print('utc rfc822: ${dateTime.getAsRfc822(false)}');
  print('local rfc822: ${dateTime.getAsRfc822(true)}');

  final dtUtc = CkDtObj();
  dateTime.toDtObj(false, dtUtc);

  print('${dtUtc.month}/${dtUtc.day}/${dtUtc.year}');

  print('success');

  // ------------------------------------------------
  // A sample JSON response:

  // 	{ 
  // 	  "id": "1XC17935MN507400J",
  // 	  "create_time": "2016-11-25T15:42:50Z",
  // 	  "update_time": "2016-11-25T15:42:56Z",
  // 	  "amount": { 
  // 	    "total": "289.00",
  // 	    "currency": "USD"
  // 	  },
  // 	  "payment_mode": "INSTANT_TRANSFER",
  // 	  "state": "completed",
  // 	  "protection_eligibility": "ELIGIBLE",
  // 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
  // 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
  // 	  "transaction_fee": { 
  // 	    "value": "8.68",
  // 	    "currency": "USD"
  // 	  },
  // 	  "links": [
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
  // 	      "rel": "self",
  // 	      "method": "GET"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
  // 	      "rel": "refund",
  // 	      "method": "POST"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
  // 	      "rel": "parent_payment",
  // 	      "method": "GET"
  // 	    }
  // 	  ]
  // 	}
}