(PHP Extension) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

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

// Clear the REST object of any headers or query params from previous requests.
$rest->ClearAllHeaders();
$rest->ClearAllQueryParams();

$rest->AddHeader('Authorization',$sbAuth->getAsString());

// To find captured payments, we list payments and look for those
// containing a "capture" resource.
$rest->AddQueryParam('count','100');
$rest->AddQueryParam('start_index','0');
$rest->AddQueryParam('sort_by','update_time');
$rest->AddQueryParam('sort_order','asc');

// Send the GET request and get the JSON response.
$sbJsonResponse = new CkStringBuilder();
$success = $rest->FullRequestNoBodySb('GET','/v1/payments/payment',$sbJsonResponse);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$json = new CkJsonObject();
$json->put_EmitCompact(false);
$json->LoadSb($sbJsonResponse);

// (optional) Save the entire JSON response to a file to examine if desired..
$sbTemp = new CkStringBuilder();
$json->EmitSb($sbTemp);
$sbTemp->WriteFile('qa_output/paypal_payments.json','utf-8',false);

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

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

// We are looking for "capture" resources .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "capture" JSON objects. 

// 	{ 
// 	  "payments": [
// 	    { 
// 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
// 	      "create_time": "2016-11-24T00:33:51Z",
// 	      "update_time": "2016-11-24T00:40:54Z",
// 	      "state": "approved",
// 	      "intent": "authorize",
// 	      "payer": { 
// 	        "payment_method": "credit_card",
// 	        "funding_instruments": [
// 	          { 
// 	            ...
// 	          }
// 	        ]
// 	      },
// 	      "transactions": [
// 	        { 
// 	          "amount": { 
// 	            ...
// 	          },
// 	          "description": "This is the payment transaction description.",
// 	          "related_resources": [
// 	            { 
// 	              "authorization": { 
// 	                ...
// 	              }
// 	            },
// 	            { 
// 	              "capture": { 
// 	                "id": "1LY5310469661362J",
// 	                "create_time": "2016-11-24T00:40:50Z",
// 	                "update_time": "2016-11-24T00:40:54Z",
// 	                "amount": { 
// 	                  "total": "4.54",
// 	                  "currency": "USD"
// 	                },
// 	                "state": "completed",
// 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	                "transaction_fee": { 
// 	                  "value": "0.43",
// 	                  "currency": "USD"
// 	                },
// 			...
// 

// Iterate over the payments and show each capture
$numPayments = $json->SizeOfArray('payments');
$i = 0;
while ($i < $numPayments) {
    $json->put_I($i);
    $j = 0;
    $numTransactions = $json->SizeOfArray('payments[i].transactions');
    while ($j < $numTransactions) {
        $json->put_J($j);
        $numRelatedResources = $json->SizeOfArray('payments[i].transactions[j].related_resources');
        $k = 0;
        while ($k < $numRelatedResources) {
            $json->put_K($k);
            if ($json->HasMember('payments[i].transactions[j].related_resources[k].capture') == true) {
                // jsonCapture is a CkJsonObject
                $jsonCapture = $json->ObjectOf('payments[i].transactions[j].related_resources[k].capture');
                print 'capture id: ' . $jsonCapture->stringOf('id') . "\n";
                print 'state: ' . $jsonCapture->stringOf('state') . "\n";
                print 'total: ' . $jsonCapture->stringOf('amount.total') . "\n";
                print '----' . "\n";

            }

            $k = $k + 1;
        }

        $j = $j + 1;
    }

    $i = $i + 1;
}

print 'success' . "\n";

?>