(PHP Extension) PayPal - Capture a Previously Authorized Payment

Captures a previously authorized payment.

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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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)
$jsonToken = new CkJsonObject();
$jsonToken->LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
$sbAuth = new 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.
$rest = new CkRest();
$bAutoReconnect = true;
$success = $rest->Connect('api.sandbox.paypal.com',443,true,$bAutoReconnect);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// ----------------------------------------------------------------------------------------------
// 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 containing the transaction information.
$json = new CkJsonObject();
$json->put_EmitCompact(false);
$json->UpdateString('amount.currency','USD');
$json->UpdateString('amount.total','4.54');
$json->UpdateBool('is_final_capture',true);
print $json->emit() . "\n";

// The JSON created by the above code:

// 	{ 
// 	  "amount": { 
// 	    "currency": "USD",
// 	    "total": "4.54"
// 	  },
// 	  "is_final_capture": true
// 	}

$rest->AddHeader('Authorization',$sbAuth->getAsString());
$rest->AddHeader('Content-Type','application/json');

// To capture payment, make a call to /v1/payments/authorization/[authorization_id]/capture with the authorization ID in the URI.
// See PayPal Authorize Payment for sample code to create the authorization.
// The "7X8332687A4929542" comes from the "transactions[0].related_resources[0].authorization.id" part of the authorization response.

$sbPath = new CkStringBuilder();
$sbPath->Append('/v1/payments/authorization/[authorization_id]/capture');
$numReplacements = $sbPath->Replace('[authorization_id]','7X8332687A4929542');

// Send the POST request containign the JSON in the request body, and get the JSON response.
$sbJsonRequest = new CkStringBuilder();
$json->put_EmitCompact(true);
$json->EmitSb($sbJsonRequest);
$sbJsonResponse = new CkStringBuilder();
$success = $rest->FullRequestSb('POST',$sbPath->getAsString(),$sbJsonRequest,$sbJsonResponse);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$json->put_EmitCompact(false);
$json->LoadSb($sbJsonResponse);

print 'Response Status Code = ' . $rest->get_ResponseStatusCode() . "\n";

// IMPORTANT: In most PayPal examples, the return status code is 201.
// For this particular call, PayPal returns status code 200.

// Did we get a 200 success response?
if ($rest->get_ResponseStatusCode() != 200) {
    print $json->emit() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response is shown below.
print $json->emit() . "\n";

print 'success' . "\n";

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

// 	{ 
// 	  "id": "1LY5310469661362J",
// 	  "create_time": "2016-11-24T00:40:50Z",
// 	  "update_time": "2016-11-24T00:40:54Z",
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "is_final_capture": true,
// 	  "state": "completed",
// 	  "reasonCode": "None",
// 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "transaction_fee": { 
// 	    "value": "0.43",
// 	    "currency": "USD"
// 	  },
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
// 	      "rel": "refund",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
// 	      "rel": "authorization",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	

?>