(Ruby) PayPal - Create Stored Credit Card Payment

Creates a credit card payment using a card ID from a previously stored credit card (where the credit card was stored in PayPal's vault).

Note: For sandbox calls, you can use the credit card numbers provided in your sandbox test accounts.

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

# We previously stored the user's credit card data in PayPal's vault.
# See Store Card in PayPal Vault for sample code.

# Build the JSON containing the stored credit card information and transaction information.
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.UpdateString("intent","sale")
json.UpdateString("payer.payment_method","credit_card")
json.UpdateString("payer.funding_instruments[0].credit_card_token.credit_card_id","CARD-52W84623JH8043102LA3CLGA")
json.UpdateString("payer.funding_instruments[0].credit_card_token.payer_id","user12345")
json.UpdateString("transactions[0].amount.total","6.70")
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",
# 	  "payer": { 
# 	    "payment_method": "credit_card",
# 	    "funding_instruments": [
# 	      { 
# 	        "credit_card_token": { 
# 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
# 	          "payer_id": "user12345"
# 	        }
# 	      }
# 	    ]
# 	  },
# 	  "transactions": [
# 	    { 
# 	      "amount": { 
# 	        "total": "6.70",
# 	        "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";

# Demonstrate how to access a few parts of the JSON response..
print "credit_card_id: " + json.stringOf("payer.funding_instruments[0].credit_card_token.credit_card_id") + "\n";
print "subtotal: " + json.stringOf("transactions[0].amount.details.subtotal") + "\n";
print "refund href: " + json.stringOf("transactions[0].related_resources[0].sale.links[1].href") + "\n";
print "success" + "\n";

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

# 	{ 
# 	  "id": "PAY-12T35751GS725073SLA3CQNQ",
# 	  "create_time": "2016-11-23T23:37:26Z",
# 	  "update_time": "2016-11-23T23:37:31Z",
# 	  "state": "approved",
# 	  "intent": "sale",
# 	  "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": [
# 	        { 
# 	          "sale": { 
# 	            "id": "4F194018A1618453G",
# 	            "create_time": "2016-11-23T23:37:26Z",
# 	            "update_time": "2016-11-23T23:37:31Z",
# 	            "amount": { 
# 	              "total": "6.70",
# 	              "currency": "USD"
# 	            },
# 	            "state": "completed",
# 	            "parent_payment": "PAY-12T35751GS725073SLA3CQNQ",
# 	            "links": [
# 	              { 
# 	                "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G",
# 	                "rel": "self",
# 	                "method": "GET"
# 	              },
# 	              { 
# 	                "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G/refund",
# 	                "rel": "refund",
# 	                "method": "POST"
# 	              },
# 	              { 
# 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
# 	                "rel": "parent_payment",
# 	                "method": "GET"
# 	              }
# 	            ],
# 	            "fmf_details": {},
# 	            "processor_response": { 
# 	              "avs_code": "X",
# 	              "cvv_code": "M"
# 	            }
# 	          }
# 	        }
# 	      ]
# 	    }
# 	  ],
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}
#