(SQL Server) CardConnect Authorization

Demonstrates how to send an Authorization request.

Authorization is the initial step in accepting payment from a cardholder. This action "authorizes" or requests permission from the bank to transfer money from the cardholder to the merchant.

See https://developer.cardconnect.com/cardconnect-api#authorization

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)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    -- Build and send the following JSON:

    -- Note: The CardConnect online documentation might use an expiry that is in the past, such as "1218".
    -- This causes the request to fail.  Use a month/year that is in the future..
    -- (Likewise, this example will have an invalid month/year after Dec 2021)

    -- {
    --   "merchid": "MERCHANT_ID",
    --   "accttype": "VISA",
    --   "orderid": "AB-11-9876",
    --   "account": "4111111111111111",
    --   "expiry": "1221",
    --   "amount": "0",
    --   "currency": "USD",
    --   "name": "TOM JONES",
    --   "address": "123 MAIN STREET",
    --   "city": "anytown",
    --   "region": "NY",
    --   "country": "US",
    --   "postal": "55555",
    --   "profile": "Y",
    --   "ecomind": "E",
    --   "cvv2": "123",
    --   "track": null,
    --   "capture": "Y"
    -- }

    -- Use this online tool to generate the code from sample JSON: 
    -- Generate Code to Create JSON
    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_OAMethod @json, 'UpdateString', @success OUT, 'merchid', 'MERCHANT_ID'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'accttype', 'VISA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'orderid', 'AB-11-9876'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account', '4111111111111111'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'expiry', '1221'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount', '20'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'currency', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'TOM JONES'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'address', '123 MAIN STREET'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'city', 'anytown'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'region', 'NY'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'country', 'US'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'postal', '55555'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'profile', 'Y'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ecomind', 'E'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'cvv2', '123'
    EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'track'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'capture', 'Y'

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://<site>.cardconnect.com:<port>/cardconnect/rest/auth'
    DECLARE @responseStr nvarchar(4000)
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @http, 'PutText', @responseStr OUT, @url, @sTmp0, 'utf-8', 'application/json', 0, 0

    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
        EXEC @hr = sp_OADestroy @json
        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
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    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

    -- Sample error:

    -- {
    --   "respproc": "PPS",
    --   "amount": "0.00",
    --   "resptext": "Invalid amount",
    --   "cardproc": "FNOR",
    --   "acctid": "1",
    --   "retref": "112804260418",
    --   "respstat": "C",
    --   "respcode": "43",
    --   "account": "41XXXXXXXXXX1111",
    --   "defaultacct": "Y",
    --   "merchid": "MERCHANT_ID",
    --   "token": "9418594164541111"
    -- }

    -- A successful response looks like this:

    -- {
    --   "amount": "0.20",
    --   "resptext": "Approval",
    --   "acctid": "1",
    --   "commcard": " C ",
    --   "cvvresp": "M",
    --   "respcode": "00",
    --   "batchid": "1900942291",
    --   "avsresp": "Z",
    --   "entrymode": "ECommerce",
    --   "defaultacct": "Y",
    --   "merchid": "MERCHANT_ID",
    --   "token": "9418594164541111",
    --   "authcode": "PPS158",
    --   "respproc": "FNOR",
    --   "bintype": "",
    --   "profileid": "16618402968441604028",
    --   "retref": "112989260941",
    --   "respstat": "A",
    --   "account": "41XXXXXXXXXX1111"
    -- }

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

    DECLARE @amount nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @amount OUT, 'amount'
    DECLARE @resptext nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @resptext OUT, 'resptext'
    DECLARE @acctid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @acctid OUT, 'acctid'
    DECLARE @commcard nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @commcard OUT, 'commcard'
    DECLARE @cvvresp nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @cvvresp OUT, 'cvvresp'
    DECLARE @respcode nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @respcode OUT, 'respcode'
    DECLARE @batchid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @batchid OUT, 'batchid'
    DECLARE @avsresp nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @avsresp OUT, 'avsresp'
    DECLARE @entrymode nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @entrymode OUT, 'entrymode'
    DECLARE @defaultacct nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @defaultacct OUT, 'defaultacct'
    DECLARE @merchid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @merchid OUT, 'merchid'
    DECLARE @token nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @token OUT, 'token'
    DECLARE @authcode nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @authcode OUT, 'authcode'
    DECLARE @respproc nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @respproc OUT, 'respproc'
    DECLARE @bintype nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @bintype OUT, 'bintype'
    DECLARE @profileid nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @profileid OUT, 'profileid'
    DECLARE @retref nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @retref OUT, 'retref'
    DECLARE @respstat nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @respstat OUT, 'respstat'
    DECLARE @account nvarchar(4000)
    EXEC sp_OAMethod @jsonResp, 'StringOf', @account OUT, 'account'

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


END
GO