(SQL Server) PayPal - Authorize a Payment

Creates an authorization for a payment. This is for the case where the payment will first be authorized, and then captured at a later date. (In other words, the buyer is providing his/her credit card information now, and the actual charge (capture) will take place at a later time.)

Creating the authorization is the same as creating "sale" payment, except the intent is set to "authorize" instead of "sale".

This example requests an authorization for a credit card payment (using a credit card ID previoulsy stored in the PayPal vault).

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', 'authorize'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payer.payment_method', 'credit_card'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payer.funding_instruments[0].credit_card_token.credit_card_id', 'CARD-52W84623JH8043102LA3CLGA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payer.funding_instruments[0].credit_card_token.payer_id', 'user12345'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.total', '6.70'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].amount.currency', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transactions[0].description', 'This is the payment transaction description.'

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

    -- The JSON created by the above code is this:

    -- 	{ 
    -- 	  "intent": "authorize",
    -- 	  "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."
    -- 	    }
    -- 	  ]
    -- 	}

    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
    -- The authorization ID found in the related_resources is used to capture the payment at a later time.

    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'transactions[0].related_resources[0].authorization.id'
    PRINT 'authorization id: ' + @sTmp0

    PRINT 'success'

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

    -- 	{ 
    -- 	  "id": "PAY-2CY489250W145633HLA3DK3Y",
    -- 	  "create_time": "2016-11-24T00:33:51Z",
    -- 	  "update_time": "2016-11-24T00:33:58Z",
    -- 	  "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": "authorized",
    -- 	            "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/authorization/7X8332687A4929542/capture",
    -- 	                "rel": "capture",
    -- 	                "method": "POST"
    -- 	              },
    -- 	              { 
    -- 	                "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542/void",
    -- 	                "rel": "void",
    -- 	                "method": "POST"
    -- 	              },
    -- 	              { 
    -- 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    -- 	                "rel": "parent_payment",
    -- 	                "method": "GET"
    -- 	              }
    -- 	            ],
    -- 	            "processor_response": { 
    -- 	              "avs_code": "X",
    -- 	              "cvv_code": "M"
    -- 	            },
    -- 	            "fmf_details": {}
    -- 	          }
    -- 	        }
    -- 	      ]
    -- 	    }
    -- 	  ],
    -- 	  "links": [
    -- 	    { 
    -- 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    -- 	      "rel": "self",
    -- 	      "method": "GET"
    -- 	    }
    -- 	  ]
    -- 	}

    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