(SQL Server) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized 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.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..
    -- ----------------------------------------------------------------------------------------------

    -- Clear the REST object of any headers or query params from previous requests.
    EXEC sp_OAMethod @rest, 'ClearAllHeaders', @success OUT
    EXEC sp_OAMethod @rest, 'ClearAllQueryParams', @success OUT

    EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0

    -- To find captured payments, we list payments and look for those
    -- containing a "capture" resource.
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'count', '100'
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'start_index', '0'
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'sort_by', 'update_time'
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'sort_order', 'asc'

    -- Send the GET request and get the JSON response.
    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, 'FullRequestNoBodySb', @success OUT, 'GET', '/v1/payments/payment', @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 @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

    -- (optional) Save the entire JSON response to a file to examine if desired..
    DECLARE @sbTemp int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbTemp OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbTemp
    EXEC sp_OAMethod @sbTemp, 'WriteFile', @success OUT, 'qa_output/paypal_payments.json', 'utf-8', 0


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

    -- Did we get a 200 success response?
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      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 @sbJsonResponse
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbTemp
        RETURN
      END

    -- We are looking for "capture" resources .
    -- As shown below, we are looking in the "transactions" for "related_resources"
    -- containing "capture" JSON objects. 

    -- 	{ 
    -- 	  "payments": [
    -- 	    { 
    -- 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
    -- 	      "create_time": "2016-11-24T00:33:51Z",
    -- 	      "update_time": "2016-11-24T00:40:54Z",
    -- 	      "state": "approved",
    -- 	      "intent": "authorize",
    -- 	      "payer": { 
    -- 	        "payment_method": "credit_card",
    -- 	        "funding_instruments": [
    -- 	          { 
    -- 	            ...
    -- 	          }
    -- 	        ]
    -- 	      },
    -- 	      "transactions": [
    -- 	        { 
    -- 	          "amount": { 
    -- 	            ...
    -- 	          },
    -- 	          "description": "This is the payment transaction description.",
    -- 	          "related_resources": [
    -- 	            { 
    -- 	              "authorization": { 
    -- 	                ...
    -- 	              }
    -- 	            },
    -- 	            { 
    -- 	              "capture": { 
    -- 	                "id": "1LY5310469661362J",
    -- 	                "create_time": "2016-11-24T00:40:50Z",
    -- 	                "update_time": "2016-11-24T00:40:54Z",
    -- 	                "amount": { 
    -- 	                  "total": "4.54",
    -- 	                  "currency": "USD"
    -- 	                },
    -- 	                "state": "completed",
    -- 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    -- 	                "transaction_fee": { 
    -- 	                  "value": "0.43",
    -- 	                  "currency": "USD"
    -- 	                },
    -- 			...
    -- 

    -- Iterate over the payments and show each capture
    DECLARE @numPayments int
    EXEC sp_OAMethod @json, 'SizeOfArray', @numPayments OUT, 'payments'
    DECLARE @i int
    SELECT @i = 0
    WHILE @i < @numPayments
      BEGIN
        EXEC sp_OASetProperty @json, 'I', @i
        DECLARE @j int
        SELECT @j = 0
        DECLARE @numTransactions int
        EXEC sp_OAMethod @json, 'SizeOfArray', @numTransactions OUT, 'payments[i].transactions'
        WHILE @j < @numTransactions
          BEGIN
            EXEC sp_OASetProperty @json, 'J', @j
            DECLARE @numRelatedResources int
            EXEC sp_OAMethod @json, 'SizeOfArray', @numRelatedResources OUT, 'payments[i].transactions[j].related_resources'
            DECLARE @k int
            SELECT @k = 0
            WHILE @k < @numRelatedResources
              BEGIN
                EXEC sp_OASetProperty @json, 'K', @k
                EXEC sp_OAMethod @json, 'HasMember', @iTmp0 OUT, 'payments[i].transactions[j].related_resources[k].capture'
                IF @iTmp0 = 1
                  BEGIN
                    DECLARE @jsonCapture int
                    EXEC sp_OAMethod @json, 'ObjectOf', @jsonCapture OUT, 'payments[i].transactions[j].related_resources[k].capture'

                    EXEC sp_OAMethod @jsonCapture, 'StringOf', @sTmp0 OUT, 'id'
                    PRINT 'capture id: ' + @sTmp0

                    EXEC sp_OAMethod @jsonCapture, 'StringOf', @sTmp0 OUT, 'state'
                    PRINT 'state: ' + @sTmp0

                    EXEC sp_OAMethod @jsonCapture, 'StringOf', @sTmp0 OUT, 'amount.total'
                    PRINT 'total: ' + @sTmp0

                    PRINT '----'
                    EXEC @hr = sp_OADestroy @jsonCapture

                  END
                SELECT @k = @k + 1
              END
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END


    PRINT 'success'

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


END
GO