Perl

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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

Perl

use chilkat();

$success = 0;

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

# Build the JSON request body containing the reminder information:
$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);
$dtNow = chilkat::CkDateTime->new();
$dtNow->SetFromCurrentSystemTime();
$sbDt = chilkat::CkStringBuilder->new();
$sbDt->Append($dtNow->getAsTimestamp(0));
$numReplaced = $sbDt->Replace("T"," ");
$numReplaced = $sbDt->Replace("Z"," UTC");
$json->UpdateString("date",$sbDt->getAsString());
$json->UpdateString("note","Refunded by credit card!");
$json->UpdateString("amount.currency","USD");
$json->UpdateString("amount.value","500.00");
print $json->emit() . "\r\n";

# The JSON created by the above code:

# 	{ 
# 	  "date": "2016-11-28 21:05:38 UTC",
# 	  "note": "Refunded by credit card!",
# 	  "amount": { 
# 	    "currency": "USD",
# 	    "value": "500.00"
# 	  }
# 	}

# Build a path using a previously-sent invoice ID.
$sbPath = chilkat::CkStringBuilder->new();
$sbPath->Append("/v1/invoicing/invoices/invoice_id/record-refund");
$numReplacements = $sbPath->Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC");

$json->put_EmitCompact(1);
$sbRequestBody = chilkat::CkStringBuilder->new();
$sbResponseBody = chilkat::CkStringBuilder->new();

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

$success = $rest->FullRequestSb("POST",$sbPath->getAsString(),$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

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

# Check for a success response.
if ($rest->get_ResponseStatusCode() != 204) {
    print $sbResponseBody->getAsString() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# For a success response, the response body is empty.
print "Success." . "\r\n";