Sample code for 30+ languages & platforms
CkPerl Requires Chilkat v11.0.0+

PayPal: Read an invoice and its outstanding balance

See more PayPal Examples

Use the PayPal invoice ID to retrieve its number, status, total and balance due. A partial external payment can reduce the balance without settling the whole invoice.

PayPal documentation

Chilkat CkPerl Downloads

CkPerl
use chilkat();

$success = 0;

#  See Unlock Chilkat before making requests.
#  For the merchant's internal backoffice application. Load the sandbox token
#  from the merchant's credential store. Keep it out of publicly distributed apps.
#  See Get a PayPal access token.
$http = chilkat::CkHttp->new();
$http->put_AuthToken("SANDBOX_ACCESS_TOKEN");
$resp = chilkat::CkHttpResponse->new();

#  The original total and the balance still due may differ after a payment.

$http->SetUrlVar("id","INVOICE_ID");

$success = $http->HttpNoBody("GET","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}",$resp);
if ($success != 1) {
    print "No HTTP response: " . $http->lastErrorText() . "\r\n";
    exit;
}

if (($resp->get_StatusCode() < 200) or ($resp->get_StatusCode() >= 300)) {
    $errorInfo = chilkat::CkJsonObject->new();
    $errorInfo->Load($resp->bodyStr());
    print "HTTP " . $resp->get_StatusCode() . " " . $errorInfo->stringOf("name") . " " . $errorInfo->stringOf("details[0].issue") . "\r\n";
    print "PayPal debug ID: " . $errorInfo->stringOf("debug_id") . "\r\n";
    exit;
}

$result = chilkat::CkJsonObject->new();
$parsed = $result->Load($resp->bodyStr());
if ($parsed != 1) {
    print "Expected a JSON response; HTTP " . $resp->get_StatusCode() . "\r\n";
    exit;
}

print "ID: " . $result->stringOf("id") . "\r\n";
print "Status: " . $result->stringOf("status") . "\r\n";
print "Number: " . $result->stringOf("detail.invoice_number") . "\r\n";
print "Total: " . $result->stringOf("amount.value") . "\r\n";
print "Currency: " . $result->stringOf("amount.currency_code") . "\r\n";
print "Balance due: " . $result->stringOf("due_amount.value") . "\r\n";