(Ruby) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# Note: Requires Chilkat v9.5.0.64 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 = true
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

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

# To refund a particular amount, build JSON such as this:
jsonPartial = Chilkat::CkJsonObject.new()
jsonPartial.put_EmitCompact(false)
jsonPartial.UpdateString("amount.total","2.34")
jsonPartial.UpdateString("amount.currency","USD")
# invoice_number is optional..
jsonPartial.UpdateString("invoice_number","INV-1234567")
print jsonPartial.emit() + "\n";

# The JSON for a partial refund:

# 	{ 
# 	  "amount": { 
# 	    "total": "2.34",
# 	    "currency": "USD"
# 	  },
# 	  "invoice_number": "INV-1234567"
# 	}

rest.AddHeader("Authorization",sbAuth.getAsString())
rest.AddHeader("Content-Type","application/json")

# 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/refund")
numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J")

# Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = Chilkat::CkStringBuilder.new()
jsonPartial.put_EmitCompact(true)
jsonPartial.EmitSb(sbJsonRequest)
sbJsonResponse = Chilkat::CkStringBuilder.new()

bFullRefund = true
# To send a full refund, send an empty request body:
if (bFullRefund == true)
    sbJsonRequest.Clear()
    sbJsonRequest.Append("{}")
end

success = rest.FullRequestSb("POST",sbPath.getAsString(),sbJsonRequest,sbJsonResponse)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.LoadSb(sbJsonResponse)

print "Response Status Code = " + rest.get_ResponseStatusCode().to_s() + "\n";

# Did we get a 201 success response?
if (rest.get_ResponseStatusCode() != 201)
    print json.emit() + "\n";
    print "Failed." + "\n";
    exit
end

print json.emit() + "\n";
print "Success." + "\n";

# A successful JSON response:
# The "id" is the refund_id.

# 	{ 
# 	  "id": "7NE550583A133505U",
# 	  "create_time": "2016-11-26T16:38:27Z",
# 	  "update_time": "2016-11-26T16:38:27Z",
# 	  "state": "completed",
# 	  "amount": { 
# 	    "total": "289.00",
# 	    "currency": "USD"
# 	  },
# 	  "sale_id": "1XC17935MN507400J",
# 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
# 	      "rel": "parent_payment",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
# 	      "rel": "sale",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}