(Excel) PayPal - Create Order

Creates a PayPal order.

"Creating a PayPal order indicates that the buyer has consented to the purchase but does not place the funds on hold. After you create an order, you can capture the order directly without any additional authorization or you can make an authorization API call to place funds on hold until you are ready to capture. Because the order does not place funds on hold, create an authorization instead of capturing an order directly.

Merchants often use this technique to accept orders for items that are not available for shipment when the order is placed. For example, when a merchant ships items from multiple distribution centers and needs separate authorizations for each shipment. Another example would be delayed shipping on items that are not in stock."

See PayPal Order Process for more information.

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

Download Excel Class Modules Chilkat Excel Class Modules

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

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' 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 Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
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 Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.UpdateString("intent","order")
success = json.UpdateString("payer.payment_method","paypal")
success = json.UpdateString("transactions[0].amount.total","30.11")
success = json.UpdateString("transactions[0].amount.currency","USD")
success = json.UpdateString("transactions[0].amount.details.subtotal","30.00")
success = json.UpdateString("transactions[0].amount.details.tax","0.07")
success = json.UpdateString("transactions[0].amount.details.shipping","0.03")
success = json.UpdateString("transactions[0].amount.details.handling_fee","1.00")
success = json.UpdateString("transactions[0].amount.details.shipping_discount","-1.00")
success = json.UpdateString("transactions[0].amount.details.insurance","0.01")
success = json.UpdateString("transactions[0].description","This is the payment transaction description.")
success = json.UpdateString("transactions[0].custom","EBAY_EMS_90048630024435")
success = json.UpdateString("transactions[0].invoice_number","48787589673")
success = json.UpdateString("transactions[0].payment_options.allowed_payment_method","INSTANT_FUNDING_SOURCE")
success = json.UpdateString("transactions[0].soft_descriptor","ECHI5786786")
success = json.UpdateString("transactions[0].item_list.items[0].name","hat")
success = json.UpdateString("transactions[0].item_list.items[0].description","Brown color hat")
success = json.UpdateString("transactions[0].item_list.items[0].quantity","5")
success = json.UpdateString("transactions[0].item_list.items[0].price","3")
success = json.UpdateString("transactions[0].item_list.items[0].tax","0.01")
success = json.UpdateString("transactions[0].item_list.items[0].sku","1")
success = json.UpdateString("transactions[0].item_list.items[0].currency","USD")
success = json.UpdateString("transactions[0].item_list.items[1].name","handbag")
success = json.UpdateString("transactions[0].item_list.items[1].description","Black color hand bag")
success = json.UpdateString("transactions[0].item_list.items[1].quantity","1")
success = json.UpdateString("transactions[0].item_list.items[1].price","15")
success = json.UpdateString("transactions[0].item_list.items[1].tax","0.02")
success = json.UpdateString("transactions[0].item_list.items[1].sku","product34")
success = json.UpdateString("transactions[0].item_list.items[1].currency","USD")
success = json.UpdateString("transactions[0].item_list.shipping_address.recipient_name","Hello World")
success = json.UpdateString("transactions[0].item_list.shipping_address.line1","4thFloor")
success = json.UpdateString("transactions[0].item_list.shipping_address.line2","unit#34")
success = json.UpdateString("transactions[0].item_list.shipping_address.city","SAn Jose")
success = json.UpdateString("transactions[0].item_list.shipping_address.country_code","US")
success = json.UpdateString("transactions[0].item_list.shipping_address.postal_code","95131")
success = json.UpdateString("transactions[0].item_list.shipping_address.phone","011862212345678")
success = json.UpdateString("transactions[0].item_list.shipping_address.state","CA")
success = json.UpdateString("note_to_payer","Contact us for any questions on your order.")
success = json.UpdateString("redirect_urls.return_url","http://www.amazon.com")
success = json.UpdateString("redirect_urls.cancel_url","http://www.hawaii.com")

Debug.Print json.Emit()

' The JSON created by the above code:

' 	{ 
' 	  "intent": "order",
' 	  "payer": { 
' 	    "payment_method": "paypal"
' 	  },
' 	  "transactions": [
' 	    { 
' 	      "amount": { 
' 	        "total": "30.11",
' 	        "currency": "USD",
' 	        "details": { 
' 	          "subtotal": "30.00",
' 	          "tax": "0.07",
' 	          "shipping": "0.03",
' 	          "handling_fee": "1.00",
' 	          "shipping_discount": "-1.00",
' 	          "insurance": "0.01"
' 	        }
' 	      },
' 	      "description": "This is the payment transaction description.",
' 	      "custom": "EBAY_EMS_90048630024435",
' 	      "invoice_number": "48787589673",
' 	      "payment_options": { 
' 	        "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
' 	      },
' 	      "soft_descriptor": "ECHI5786786",
' 	      "item_list": { 
' 	        "items": [
' 	          { 
' 	            "name": "hat",
' 	            "description": "Brown color hat",
' 	            "quantity": "5",
' 	            "price": "3",
' 	            "tax": "0.01",
' 	            "sku": "1",
' 	            "currency": "USD"
' 	          },
' 	          { 
' 	            "name": "handbag",
' 	            "description": "Black color hand bag",
' 	            "quantity": "1",
' 	            "price": "15",
' 	            "tax": "0.02",
' 	            "sku": "product34",
' 	            "currency": "USD"
' 	          }
' 	        ],
' 	        "shipping_address": { 
' 	          "recipient_name": "Hello World",
' 	          "line1": "4thFloor",
' 	          "line2": "unit#34",
' 	          "city": "SAn Jose",
' 	          "country_code": "US",
' 	          "postal_code": "95131",
' 	          "phone": "011862212345678",
' 	          "state": "CA"
' 	        }
' 	      }
' 	    }
' 	  ],
' 	  "note_to_payer": "Contact us for any questions on your order.",
' 	  "redirect_urls": { 
' 	    "return_url": "http://www.amazon.com",
' 	    "cancel_url": "http://www.hawaii.com"
' 	  }
' 	}
' 
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 Chilkat.StringBuilder
Set sbJsonRequest = Chilkat.NewStringBuilder
json.EmitCompact = True
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder
success = rest.FullRequestSb("POST","/v1/payments/payment",sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
    Debug.Print json.Emit()
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response is shown below.
Debug.Print json.Emit()

Debug.Print "success"

' ------------------------------------------------
' A sample JSON response:

' 	{ 
' 	  "id": "PAY-4G829619WD096761LLA3DYAQ",
' 	  "intent": "order",
' 	  "state": "created",
' 	  "payer": { 
' 	    "payment_method": "paypal",
' 	    "use_vendor_currency_conversion": false
' 	  },
' 	  "transactions": [
' 	    { 
' 	      "amount": { 
' 	        "total": "30.11",
' 	        "currency": "USD",
' 	        "details": { 
' 	          "subtotal": "30.00",
' 	          "tax": "0.07",
' 	          "shipping": "0.03",
' 	          "insurance": "0.01",
' 	          "handling_fee": "1.00",
' 	          "shipping_discount": "-1.00"
' 	        }
' 	      },
' 	      "description": "This is the payment transaction description.",
' 	      "custom": "EBAY_EMS_90048630024435",
' 	      "invoice_number": "48787589673",
' 	      "soft_descriptor": "ECHI5786786",
' 	      "payment_options": { 
' 	        "allowed_payment_method": "INSTANT_FUNDING_SOURCE",
' 	        "recurring_flag": false,
' 	        "skip_fmf": false
' 	      },
' 	      "item_list": { 
' 	        "items": [
' 	          { 
' 	            "name": "hat",
' 	            "sku": "1",
' 	            "description": "Brown color hat",
' 	            "price": "3.00",
' 	            "currency": "USD",
' 	            "tax": "0.01",
' 	            "quantity": 5
' 	          },
' 	          { 
' 	            "name": "handbag",
' 	            "sku": "product34",
' 	            "description": "Black color hand bag",
' 	            "price": "15.00",
' 	            "currency": "USD",
' 	            "tax": "0.02",
' 	            "quantity": 1
' 	          }
' 	        ],
' 	        "shipping_address": { 
' 	          "recipient_name": "Hello World",
' 	          "line1": "4thFloor",
' 	          "line2": "unit#34",
' 	          "city": "SAn Jose",
' 	          "state": "CA",
' 	          "postal_code": "95131",
' 	          "country_code": "US",
' 	          "phone": "011862212345678"
' 	        }
' 	      },
' 	      "related_resources": [
' 	      ]
' 	    }
' 	  ],
' 	  "note_to_payer": "Contact us for any questions on your order.",
' 	  "create_time": "2016-11-24T01:01:54Z",
' 	  "links": [
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ",
' 	      "rel": "self",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0LS838292T986021B",
' 	      "rel": "approval_url",
' 	      "method": "REDIRECT"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ/execute",
' 	      "rel": "execute",
' 	      "method": "POST"
' 	    }
' 	  ]
' 	}