Ruby
Ruby
PayPal - Show Payment Details
See more PayPal Examples
Shows details for a payment by ID.Chilkat Ruby Downloads
require 'chilkat'
success = false
# 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 == false)
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..
# ----------------------------------------------------------------------------------------------
# Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders()
rest.ClearAllQueryParams()
rest.AddHeader("Authorization",sbAuth.getAsString())
# The payment ID is added to the path.
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/v1/payments/payment/payment_id")
numReplaced = sbPath.Replace("payment_id","PAY-62106714J93631829LA44NWI")
# Send the GET request and get the JSON response.
sbJsonResponse = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET",sbPath.getAsString(),sbJsonResponse)
if (success == false)
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 200 success response?
if (rest.get_ResponseStatusCode() != 200)
print json.emit() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response is shown below.
print json.emit() + "\n";
print "----------------------" + "\n";
# Show how to get a timestamp, such as update_time.
dateTime = Chilkat::CkDateTime.new()
success = dateTime.SetFromTimestamp(json.stringOf("update_time"))
print "utc update_time: " + dateTime.getAsTimestamp(false) + "\n";
print "local update_time: " + dateTime.getAsTimestamp(true) + "\n";
print "utc rfc822: " + dateTime.getAsRfc822(false) + "\n";
print "local rfc822: " + dateTime.getAsRfc822(true) + "\n";
dtUtc = Chilkat::CkDtObj.new()
dateTime.ToDtObj(false,dtUtc)
print dtUtc.get_Month().to_s() + "/" + dtUtc.get_Day().to_s() + "/" + dtUtc.get_Year().to_s() + "\n";
print "success" + "\n";
# ------------------------------------------------
# A sample JSON response:
# {
# "id": "PAY-2CY489250W145633HLA3DK3Y",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:40:54Z",
# "state": "approved",
# "intent": "authorize",
# "payer": {
# "payment_method": "credit_card",
# "funding_instruments": [
# {
# "credit_card_token": {
# "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
# "payer_id": "user12345",
# "last4": "9974",
# "type": "visa",
# "expire_month": "9",
# "expire_year": "2021"
# }
# }
# ]
# },
# "transactions": [
# {
# "amount": {
# "total": "6.70",
# "currency": "USD",
# "details": {
# "subtotal": "6.70"
# }
# },
# "description": "This is the payment transaction description.",
# "related_resources": [
# {
# "authorization": {
# "id": "7X8332687A4929542",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:33:58Z",
# "amount": {
# "total": "6.70",
# "currency": "USD",
# "details": {
# "subtotal": "6.70"
# }
# },
# "state": "captured",
# "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# "valid_until": "2016-12-23T00:33:51Z",
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# },
# {
# "capture": {
# "id": "1LY5310469661362J",
# "create_time": "2016-11-24T00:40:50Z",
# "update_time": "2016-11-24T00:40:54Z",
# "amount": {
# "total": "4.54",
# "currency": "USD"
# },
# "state": "completed",
# "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# "transaction_fee": {
# "value": "0.43",
# "currency": "USD"
# },
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
# "rel": "refund",
# "method": "POST"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# }
# ]
# }
# ],
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "self",
# "method": "GET"
# }
# ]
# }