Dart

PayPal - Get Authorization Details

See more PayPal Examples

Shows details for an authorization, by ID.

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

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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)
  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();

  // This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
  rest.addHeader('Authorization', sbAuth.getAsString());

  // The authorization ID is added to the path.
  // To list your authorizations, Find Authorizations. 
  // Authorizations in the list have an authorization object with a state of "authorized".
  final sbPath = CkStringBuilder();
  sbPath.append('/v1/payments/authorization/authorization_id');
  final numReplaced = sbPath.replace('authorization_id', '6HG91590AX913463C');

  // 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('----------------------');

  print('success');

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

  // 	{ 
  // 	  "id": "6HG91590AX913463C",
  // 	  "create_time": "2016-11-24T00:36:19Z",
  // 	  "update_time": "2016-11-24T00:36:24Z",
  // 	  "amount": { 
  // 	    "total": "6.70",
  // 	    "currency": "USD",
  // 	    "details": { 
  // 	      "subtotal": "6.70"
  // 	    }
  // 	  },
  // 	  "payment_mode": "INSTANT_TRANSFER",
  // 	  "state": "authorized",
  // 	  "protection_eligibility": "ELIGIBLE",
  // 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
  // 	  "parent_payment": "PAY-3SL8976592063093RLA3DMAY",
  // 	  "valid_until": "2016-12-23T00:36:19Z",
  // 	  "links": [
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C",
  // 	      "rel": "self",
  // 	      "method": "GET"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C/capture",
  // 	      "rel": "capture",
  // 	      "method": "POST"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C/void",
  // 	      "rel": "void",
  // 	      "method": "POST"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-3SL8976592063093RLA3DMAY",
  // 	      "rel": "parent_payment",
  // 	      "method": "GET"
  // 	    }
  // 	  ]
  // 	}
}