Xojo Plugin

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.

Xojo Plugin

Dim success As Boolean
success = False

// 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)
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = 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.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// ----------------------------------------------------------------------------------------------
// 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.
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.UpdateString("intent","sale")
success = json.UpdateString("redirect_urls.return_url","http://www.example.com/return_url")
success = json.UpdateString("redirect_urls.cancel_url","http://www.example.com/cancel_url")
success = json.UpdateString("payer.payment_method","paypal")
success = json.UpdateString("transactions[0].amount.total","7.47")
success = json.UpdateString("transactions[0].amount.currency","USD")
success = json.UpdateString("transactions[0].description","This is the payment transaction description.")

System.DebugLog(json.Emit())

// 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."
// 	    }
// 	  ]
// 	}

success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")

// Send the POST request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As New Chilkat.StringBuilder
json.EmitCompact = True
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/v1/payments/payment",sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response is shown below.
System.DebugLog(json.Emit())
System.DebugLog("success")

// ------------------------------------------------
// 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"
// 	    }
// 	  ]
// 	}