(PHP ActiveX) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?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)
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonToken = new COM("Chilkat.JsonObject");
$jsonToken->LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbAuth = new COM("Chilkat.StringBuilder");
// 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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Rest')
$rest = new COM("Chilkat.Rest");
$bAutoReconnect = 1;
$success = $rest->Connect('api.sandbox.paypal.com',443,1,$bAutoReconnect);
if ($success != 1) {
    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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbJsonResponse = new COM("Chilkat.StringBuilder");
$success = $rest->FullRequestNoBodySb('GET','/v1/payments/payment',$sbJsonResponse);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->EmitCompact = 0;
$json->LoadSb($sbJsonResponse);

// (optional) Save the entire JSON response to a file to examine if desired..
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbTemp = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbTemp);
$sbTemp->WriteFile('qa_output/paypal_payments.json','utf-8',0);

print 'Response Status Code = ' . $rest->ResponseStatusCode . "\n";

// Did we get a 200 success response?
if ($rest->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->I = $i;
    $j = 0;
    $numTransactions = $json->SizeOfArray('payments[i].transactions');
    while ($j < $numTransactions) {
        $json->J = $j;
        $numRelatedResources = $json->SizeOfArray('payments[i].transactions[j].related_resources');
        $k = 0;
        while ($k < $numRelatedResources) {
            $json->K = $k;
            if ($json->HasMember('payments[i].transactions[j].related_resources[k].capture') == 1) {
                // jsonCapture is a Chilkat.JsonObject
                $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";

?>