(SQL Server) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

    -- To refund a particular amount, build JSON such as this:
    DECLARE @jsonPartial int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonPartial OUT

    EXEC sp_OASetProperty @jsonPartial, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonPartial, 'UpdateString', @success OUT, 'amount.total', '2.34'
    EXEC sp_OAMethod @jsonPartial, 'UpdateString', @success OUT, 'amount.currency', 'USD'
    -- invoice_number is optional..
    EXEC sp_OAMethod @jsonPartial, 'UpdateString', @success OUT, 'invoice_number', 'INV-1234567'
    EXEC sp_OAMethod @jsonPartial, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- The JSON for a partial refund:

    -- 	{ 
    -- 	  "amount": { 
    -- 	    "total": "2.34",
    -- 	    "currency": "USD"
    -- 	  },
    -- 	  "invoice_number": "INV-1234567"
    -- 	}

    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'

    -- The sale ID is added to the path.
    -- The sale ID is obtained from payment records as shown here: Find Completed Sales
    DECLARE @sbPath int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPath OUT

    EXEC sp_OAMethod @sbPath, 'Append', @success OUT, '/v1/payments/sale/sale_id/refund'
    DECLARE @numReplaced int
    EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, 'sale_id', '1XC17935MN507400J'

    -- 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 @jsonPartial, 'EmitCompact', 1
    EXEC sp_OAMethod @jsonPartial, '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

    DECLARE @bFullRefund int
    SELECT @bFullRefund = 1
    -- To send a full refund, send an empty request body:
    IF @bFullRefund = 1
      BEGIN
        EXEC sp_OAMethod @sbJsonRequest, 'Clear', NULL
        EXEC sp_OAMethod @sbJsonRequest, 'Append', @success OUT, '{}'
      END
    EXEC sp_OAMethod @sbPath, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', @sTmp0, @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 @jsonPartial
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @sbJsonRequest
        EXEC @hr = sp_OADestroy @sbJsonResponse
        RETURN
      END

    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, '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 @jsonPartial
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @sbJsonRequest
        EXEC @hr = sp_OADestroy @sbJsonResponse
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

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

    PRINT 'Success.'

    -- A successful JSON response:
    -- The "id" is the refund_id.

    -- 	{ 
    -- 	  "id": "7NE550583A133505U",
    -- 	  "create_time": "2016-11-26T16:38:27Z",
    -- 	  "update_time": "2016-11-26T16:38:27Z",
    -- 	  "state": "completed",
    -- 	  "amount": { 
    -- 	    "total": "289.00",
    -- 	    "currency": "USD"
    -- 	  },
    -- 	  "sale_id": "1XC17935MN507400J",
    -- 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
    -- 	  "links": [
    -- 	    { 
    -- 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
    -- 	      "rel": "self",
    -- 	      "method": "GET"
    -- 	    },
    -- 	    { 
    -- 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
    -- 	      "rel": "parent_payment",
    -- 	      "method": "GET"
    -- 	    },
    -- 	    { 
    -- 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
    -- 	      "rel": "sale",
    -- 	      "method": "GET"
    -- 	    }
    -- 	  ]
    -- 	}

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


END
GO