Dart

PayPal - Mark Invoice as Paid

See more PayPal Examples

Mark an invoice as paid.

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..
  // ----------------------------------------------------------------------------------------------

  // Build the JSON request body containing the reminder information:
  final json = CkJsonObject();
  json.emitCompact = false;
  json.updateString('method', 'CREDIT_CARD');
  final dtNow = CkDateTime();
  dtNow.setFromCurrentSystemTime();
  final sbDt = CkStringBuilder();
  sbDt.append(dtNow.getAsTimestamp(false));
  var numReplaced = sbDt.replace('T', ' ');
  numReplaced = sbDt.replace('Z', ' UTC');
  json.updateString('date', sbDt.getAsString());
  json.updateString('note', 'I got the payment by credit card!');
  json.updateString('amount.currency', 'USD');
  json.updateString('amount.value', '500.00');
  print(json.emit());

  // The JSON created by the above code:

  // 	{ 
  // 	  "method": "CREDIT_CARD",
  // 	  "date": "2016-11-28 21:05:38 UTC",
  // 	  "note": "I got the payment by credit card!",
  // 	  "amount": { 
  // 	    "currency": "USD",
  // 	    "value": "500.00"
  // 	  }
  // 	}

  // Build a path using a previously-sent invoice ID.
  final sbPath = CkStringBuilder();
  sbPath.append('/v1/invoicing/invoices/invoice_id/record-payment');
  final numReplacements = sbPath.replace('invoice_id', 'INV2-QCHR-QHSD-M2VU-AVXC');

  json.emitCompact = true;
  final sbRequestBody = CkStringBuilder();
  final sbResponseBody = CkStringBuilder();

  rest.addHeader('Content-Type', 'application/json');
  rest.addHeader('Authorization', sbAuth.getAsString());
  json.emitSb(sbRequestBody);

  try {
    rest.fullRequestSb('POST', sbPath.getAsString(), sbRequestBody, sbResponseBody);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  // Check for a success response.
  if (rest.responseStatusCode != 204) {
    print(sbResponseBody.getAsString());
    print('Failed.');
    return;
  }

  // For a success response, the response body is empty.
  print('Success.');
}