SQL Server
SQL Server
PayPal - Refund Captured Payment
See more PayPal Examples
Refunds a captured payment, by ID. Include an amount object in the JSON request body.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat SQL Server Downloads
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- 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
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/paypal.json'
-- Build the Authorization request header field value.
DECLARE @sbAuth int
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
EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
DECLARE @bAutoReconnect int
SELECT @bAutoReconnect = 1
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 @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OASetProperty @json, 'EmitCompact', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount.total', '4.54'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount.currency', 'USD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'description', 'Athletic socks'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reason', 'Refunding because color was incorrect'
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- The JSON:
-- {
-- "amount": {
-- "total": "4.54",
-- "currency": "USD"
-- },
-- "description": "Athletic socks",
-- "reason": "Refunding because color was incorrect"
-- }
--
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 capture ID is added to the path.
-- To list your captures: Find Captures.
DECLARE @sbPath int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPath OUT
EXEC sp_OAMethod @sbPath, 'Append', @success OUT, '/v1/payments/capture/capture_id/refund'
DECLARE @numReplaced int
EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, 'capture_id', '1LY5310469661362J'
-- Send the POST request containign the JSON in the request body, and get the JSON response.
DECLARE @sbJsonRequest int
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
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJsonResponse OUT
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 @json
EXEC @hr = sp_OADestroy @sbPath
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 @sbPath
EXEC @hr = sp_OADestroy @sbJsonRequest
EXEC @hr = sp_OADestroy @sbJsonResponse
RETURN
END
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Success.'
-- A successful JSON response:
-- The "id" is the refund_id.
-- {
-- "id": "77B77607RR7243500",
-- "create_time": "2016-11-27T01:38:25Z",
-- "update_time": "2016-11-27T01:38:25Z",
-- "state": "completed",
-- "amount": {
-- "total": "4.54",
-- "currency": "USD"
-- },
-- "capture_id": "1LY5310469661362J",
-- "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
-- "rel": "parent_payment",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
-- "rel": "capture",
-- "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 @sbPath
EXEC @hr = sp_OADestroy @sbJsonRequest
EXEC @hr = sp_OADestroy @sbJsonResponse
END
GO