Dart

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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

  // To refund a particular amount, build JSON such as this:
  final json = CkJsonObject();
  json.emitCompact = false;
  json.updateString('amount.total', '4.54');
  json.updateString('amount.currency', 'USD');
  json.updateString('description', 'Athletic socks');
  json.updateString('reason', 'Refunding because color was incorrect');
  print(json.emit());

  // The JSON:

  // 	{ 
  // 	  "amount": { 
  // 	    "total": "4.54",
  // 	    "currency": "USD"
  // 	  },
  // 	  "description": "Athletic socks",
  // 	  "reason": "Refunding because color was incorrect"
  // 	}
  // 
  rest.addHeader('Authorization', sbAuth.getAsString());
  rest.addHeader('Content-Type', 'application/json');

  // The capture ID is added to the path.
  // To list your captures: Find Captures. 
  final sbPath = CkStringBuilder();
  sbPath.append('/v1/payments/capture/capture_id/refund');
  final numReplaced = sbPath.replace('capture_id', '1LY5310469661362J');

  // Send the POST request containign the JSON in the request body, and get the JSON response.
  final sbJsonRequest = CkStringBuilder();
  json.emitCompact = true;
  json.emitSb(sbJsonRequest);
  final sbJsonResponse = CkStringBuilder();

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

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

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

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

  print(json.emit());
  print('Success.');

  // A successful JSON response:
  // The "id" is the refund_id.

  // 	{ 
  // 	  "id": "77B77607RR7243500",
  // 	  "create_time": "2016-11-27T01:38:25Z",
  // 	  "update_time": "2016-11-27T01:38:25Z",
  // 	  "state": "completed",
  // 	  "amount": { 
  // 	    "total": "4.54",
  // 	    "currency": "USD"
  // 	  },
  // 	  "capture_id": "1LY5310469661362J",
  // 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
  // 	  "links": [
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
  // 	      "rel": "self",
  // 	      "method": "GET"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
  // 	      "rel": "parent_payment",
  // 	      "method": "GET"
  // 	    },
  // 	    { 
  // 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
  // 	      "rel": "capture",
  // 	      "method": "GET"
  // 	    }
  // 	  ]
  // 	}
}