(Ruby) PayPal - Create a PayPal Payment

See more PayPal Examples

Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card).

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.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 containing the transaction information.
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.UpdateString("intent","sale")
json.UpdateString("redirect_urls.return_url","http://www.example.com/return_url")
json.UpdateString("redirect_urls.cancel_url","http://www.example.com/cancel_url")
json.UpdateString("payer.payment_method","paypal")
json.UpdateString("transactions[0].amount.total","7.47")
json.UpdateString("transactions[0].amount.currency","USD")
json.UpdateString("transactions[0].description","This is the payment transaction description.")

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

# The JSON created by the above code is this:

# 	{ 
# 	  "intent": "sale",
# 	  "redirect_urls": { 
# 	    "return_url": "http://www.example.com/return_url",
# 	    "cancel_url": "http://www.example.com/cancel_url"
# 	  },
# 	  "payer": { 
# 	    "payment_method": "paypal"
# 	  },
# 	  "transactions": [
# 	    { 
# 	      "amount": { 
# 	        "total": "7.47",
# 	        "currency": "USD"
# 	      },
# 	      "description": "This is the payment transaction description."
# 	    }
# 	  ]
# 	}

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

# Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = Chilkat::CkStringBuilder.new()
json.put_EmitCompact(true)
json.EmitSb(sbJsonRequest)
sbJsonResponse = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/v1/payments/payment",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 201 success response?
if (rest.get_ResponseStatusCode() != 201)
    print json.emit() + "\n";
    print "Failed." + "\n";
    exit
end

# Sample JSON response is shown below.
print json.emit() + "\n";
print "success" + "\n";

# ------------------------------------------------
# A sample JSON response:

# 	{ 
# 	  "id": "PAY-1XK50350XV338620BLA3CZGI",
# 	  "intent": "sale",
# 	  "state": "created",
# 	  "payer": { 
# 	    "payment_method": "paypal",
# 	    "use_vendor_currency_conversion": false
# 	  },
# 	  "transactions": [
# 	    { 
# 	      "amount": { 
# 	        "total": "7.47",
# 	        "currency": "USD"
# 	      },
# 	      "description": "This is the payment transaction description.",
# 	      "related_resources": [
# 	      ]
# 	    }
# 	  ],
# 	  "create_time": "2016-11-23T23:56:09Z",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
# 	      "rel": "approval_url",
# 	      "method": "REDIRECT"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
# 	      "rel": "execute",
# 	      "method": "POST"
# 	    }
# 	  ]
# 	}