(Ruby) PayPal - Void an Authorization

Voids a previously authorized payment.

Note: A fully captured authorization cannot be voided.

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

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

# This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
rest.AddHeader("Authorization",sbAuth.getAsString())
rest.AddHeader("Content-Type","application/json")

# The authorization ID is added to the path.
# The authorization ID is obtained from payment records as shown here: Find Authorizations
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/v1/payments/authorization/authorization_id/void")
numReplaced = sbPath.Replace("authorization_id","0SU72290A8399291G")

# Send the POST request containing an empty JSON body, and get the JSON response.
sbJsonRequest = Chilkat::CkStringBuilder.new()
sbJsonRequest.Append("{}")

sbJsonResponse = Chilkat::CkStringBuilder.new()

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

json.put_EmitCompact(false)
json.LoadSb(sbJsonResponse)

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

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

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

# A successful JSON response:

# 	{ 
# 	  "id": "0SU72290A8399291G",
# 	  "create_time": "2016-11-26T17:31:05Z",
# 	  "update_time": "2016-11-26T17:31:10Z",
# 	  "amount": { 
# 	    "total": "6.70",
# 	    "currency": "USD",
# 	    "details": { 
# 	      "subtotal": "6.70"
# 	    }
# 	  },
# 	  "state": "voided",
# 	  "parent_payment": "PAY-62106714J93631829LA44NWI",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/0SU72290A8399291G",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-62106714J93631829LA44NWI",
# 	      "rel": "parent_payment",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}