(Perl) PayPal - Get Sale Details

Shows details for a sale transaction, by ID.

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

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

# Build the Authorization request header field value.
$sbAuth = chilkat::CkStringBuilder->new();
# 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 = chilkat::CkRest->new();
$bAutoReconnect = 1;
$success = $rest->Connect("api.sandbox.paypal.com",443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\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());

# The sale ID is added to the path.
# The sale ID is obtained from payment records as shown here: Find Completed Sales
$sbPath = chilkat::CkStringBuilder->new();
$sbPath->Append("/v1/payments/sale/sale_id");
$numReplaced = $sbPath->Replace("sale_id","1XC17935MN507400J");

# Send the GET request and get the JSON response.
$sbJsonResponse = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET",$sbPath->getAsString(),$sbJsonResponse);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);
$json->LoadSb($sbJsonResponse);

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

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

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

# Show how to get a timestamp, such as update_time.
$dateTime = chilkat::CkDateTime->new();
$success = $dateTime->SetFromTimestamp($json->stringOf("update_time"));
print "utc update_time: " . $dateTime->getAsTimestamp(0) . "\r\n";
print "local update_time: " . $dateTime->getAsTimestamp(1) . "\r\n";
print "utc rfc822: " . $dateTime->getAsRfc822(0) . "\r\n";
print "local rfc822: " . $dateTime->getAsRfc822(1) . "\r\n";

# dtUtc is a DtObj
$dtUtc = $dateTime->GetDtObj(0);
print $dtUtc->get_Month() . "/" . $dtUtc->get_Day() . "/" . $dtUtc->get_Year() . "\r\n";

print "success" . "\r\n";

# ------------------------------------------------
# A sample JSON response:

# 	{ 
# 	  "id": "1XC17935MN507400J",
# 	  "create_time": "2016-11-25T15:42:50Z",
# 	  "update_time": "2016-11-25T15:42:56Z",
# 	  "amount": { 
# 	    "total": "289.00",
# 	    "currency": "USD"
# 	  },
# 	  "payment_mode": "INSTANT_TRANSFER",
# 	  "state": "completed",
# 	  "protection_eligibility": "ELIGIBLE",
# 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
# 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
# 	  "transaction_fee": { 
# 	    "value": "8.68",
# 	    "currency": "USD"
# 	  },
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
# 	      "rel": "refund",
# 	      "method": "POST"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
# 	      "rel": "parent_payment",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}