Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
CardConnect
Cloudfare
Facebook
GeoOp
Jira
Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans

PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(Ruby) PayPal - Mark Invoice as Paid

Mark an invoice as paid.

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

Chilkat Ruby Downloads

Ruby Library for Linux and MAC OS X

require '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 = 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..
# ----------------------------------------------------------------------------------------------

# Build the JSON request body containing the reminder information:
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.UpdateString("method","CREDIT_CARD")
dtNow = Chilkat::CkDateTime.new()
dtNow.SetFromCurrentSystemTime()
sbDt = Chilkat::CkStringBuilder.new()
sbDt.Append(dtNow.getAsTimestamp(false))
numReplaced = sbDt.Replace("T"," ")
numReplaced = sbDt.Replace("Z"," UTC")
json.UpdateString("date",sbDt.getAsString())
json.UpdateString("note","I got the payment by credit card!")
json.UpdateString("amount.currency","USD")
json.UpdateString("amount.value","500.00")
print json.emit() + "\n";

# The JSON created by the above code:

# 	{ 
# 	  "method": "CREDIT_CARD",
# 	  "date": "2016-11-28 21:05:38 UTC",
# 	  "note": "I got the payment 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-payment")
numReplacements = sbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

json.put_EmitCompact(true)
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 != true)
    print rest.lastErrorText() + "\n";
    exit
end

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

# Check for a success response.
if (rest.get_ResponseStatusCode() != 204)
    print sbResponseBody.getAsString() + "\n";
    print "Failed." + "\n";
    exit
end

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

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.