SQL Server

CardConnect Settlement Status

See more CardConnect Examples

Demonstrates how to get the status of transactions which have been submitted to the processor for settlement.

The settlement status service returns the status of transactions which have been submitted to the processor for settlement. The transaction’s setlstatus is updated appropriately when CardConnect’s receives a response from the processor. You can either specify a batchid to return a specific batch of transactions, or use a date to return all transactions settled for that date. ...

See https://developer.cardconnect.com/cardconnect-api#settlement-status

SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', 'API_USERNAME'
    EXEC sp_OASetProperty @http, 'Password', 'API_PASSWORD'

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://<site>.cardconnect.com:<port>/cardconnect/rest/settlestat?merchid=<merchid>&batchid=<batchid>'
    DECLARE @responseStr nvarchar(4000)
    EXEC sp_OAMethod @http, 'QuickGetStr', @responseStr OUT, @url
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- A response status of 200 indicates potential success.  The JSON response body
    -- must be examined to determine if it was truly successful or an error.

    EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
    PRINT 'response status code = ' + @iTmp0

    DECLARE @jsonResp int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonResp OUT

    EXEC sp_OAMethod @jsonResp, 'Load', @success OUT, @responseStr
    EXEC sp_OASetProperty @jsonResp, 'EmitCompact', 0


    PRINT 'response JSON:'
    EXEC sp_OAMethod @jsonResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- A successful response looks like this:

    -- {
    --   "respproc": "FNOR",
    --   "hostbatch": "",
    --   "refundtotal": "0.00",
    --   "batchid": "1900942291",
    --   "chargetotal": "0.00",
    --   "hoststat": "",
    --   "merchid": "MERCHANT_ID",
    --   "txns": [
    --     {
    --       "setlamount": "13.28",
    --       "setlstat": "R",
    --       "salesdoc": "rosedale_1555412201_392",
    --       "retref": "106631225001"
    --     },
    --     {
    --       "setlamount": "13.28",
    --       "setlstat": "R",
    --       "salesdoc": "rosedale_1555412353_392",
    --       "retref": "106731125153"
    --     },
    --     {
    --       "setlamount": "7.64",
    --       "setlstat": "R",
    --       "salesdoc": "rosedale_1555414960_393",
    --       "retref": "106008227760"
    --     }
    --   ]
    -- }

    -- Use this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    DECLARE @setlamount nvarchar(4000)

    DECLARE @setlstat nvarchar(4000)

    DECLARE @salesdoc nvarchar(4000)

    DECLARE @retref nvarchar(4000)

    DECLARE @respproc nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @respproc OUT, 'respproc'
    DECLARE @hostbatch nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @hostbatch OUT, 'hostbatch'
    DECLARE @refundtotal nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @refundtotal OUT, 'refundtotal'
    DECLARE @batchid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @batchid OUT, 'batchid'
    DECLARE @chargetotal nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @chargetotal OUT, 'chargetotal'
    DECLARE @hoststat nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @hoststat OUT, 'hoststat'
    DECLARE @merchid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @merchid OUT, 'merchid'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jsonResp, 'SizeOfArray', @count_i OUT, 'txns'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jsonResp, 'I', @i
        EXEC sp_OAMethod @jsonResp, 'StringOf', @setlamount OUT, 'txns[i].setlamount'
        EXEC sp_OAMethod @jsonResp, 'StringOf', @setlstat OUT, 'txns[i].setlstat'
        EXEC sp_OAMethod @jsonResp, 'StringOf', @salesdoc OUT, 'txns[i].salesdoc'
        EXEC sp_OAMethod @jsonResp, 'StringOf', @retref OUT, 'txns[i].retref'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @jsonResp


END
GO