(SQL Server) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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)
    DECLARE @jsonToken int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/paypal.json'

    -- Build the Authorization request header field value.
    DECLARE @sbAuth int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbAuth OUT

    -- token_type should be "Bearer"
    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'token_type'
    EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, @sTmp0
    EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, ' '
    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
    EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, @sTmp0

    -- 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.
    DECLARE @rest int
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT

    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    DECLARE @success int
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'api.sandbox.paypal.com', 443, 1, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @sbAuth
        EXEC @hr = sp_OADestroy @rest
        RETURN
      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.
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OASetProperty @json, 'EmitCompact', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'intent', 'order'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payer.payment_method', 'paypal'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.total', '30.11'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.currency', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.subtotal', '30.00'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.tax', '0.07'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.shipping', '0.03'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.handling_fee', '1.00'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.shipping_discount', '-1.00'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.details.insurance', '0.01'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].description', 'This is the payment transaction description.'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].custom', 'EBAY_EMS_90048630024435'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].invoice_number', '48787589673'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].payment_options.allowed_payment_method', 'INSTANT_FUNDING_SOURCE'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].soft_descriptor', 'ECHI5786786'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].name', 'hat'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].description', 'Brown color hat'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].quantity', '5'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].price', '3'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].tax', '0.01'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].sku', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[0].currency', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].name', 'handbag'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].description', 'Black color hand bag'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].quantity', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].price', '15'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].tax', '0.02'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].sku', 'product34'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.items[1].currency', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.recipient_name', 'Hello World'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.line1', '4thFloor'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.line2', 'unit#34'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.city', 'SAn Jose'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.country_code', 'US'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.postal_code', '95131'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.phone', '011862212345678'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].item_list.shipping_address.state', 'CA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'note_to_payer', 'Contact us for any questions on your order.'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'redirect_urls.return_url', 'http://www.amazon.com'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'redirect_urls.cancel_url', 'http://www.hawaii.com'

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- 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"
    -- 	  }
    -- 	}
    -- 
    EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/json'

    -- Send the POST request containign the JSON in the request body, and get the JSON response.
    DECLARE @sbJsonRequest int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonRequest OUT

    EXEC sp_OASetProperty @json, 'EmitCompact', 1
    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbJsonRequest
    DECLARE @sbJsonResponse int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonResponse OUT

    EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', '/v1/payments/payment', @sbJsonRequest, @sbJsonResponse
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @sbAuth
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbJsonRequest
        EXEC @hr = sp_OADestroy @sbJsonResponse
        RETURN
      END

    EXEC sp_OASetProperty @json, 'EmitCompact', 0
    EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbJsonResponse


    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    PRINT 'Response Status Code = ' + @iTmp0

    -- Did we get a 201 success response?
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 201
      BEGIN
        EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @sbAuth
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbJsonRequest
        EXEC @hr = sp_OADestroy @sbJsonResponse
        RETURN
      END

    -- Sample JSON response is shown below.
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0


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

    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @sbAuth
    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbJsonRequest
    EXEC @hr = sp_OADestroy @sbJsonResponse


END
GO