(Ruby) CardConnect Settlement Status

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("API_USERNAME")
http.put_Password("API_PASSWORD")

url = "https://<site>.cardconnect.com:<port>/cardconnect/rest/settlestat?merchid=<merchid>&batchid=<batchid>"
responseStr = http.quickGetStr(url)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
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.
print "response status code = " + http.get_LastStatus().to_s() + "\n";

jsonResp = Chilkat::CkJsonObject.new()
jsonResp.Load(responseStr)
jsonResp.put_EmitCompact(false)

print "response JSON:" + "\n";
print jsonResp.emit() + "\n";

# 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

respproc = jsonResp.stringOf("respproc")
hostbatch = jsonResp.stringOf("hostbatch")
refundtotal = jsonResp.stringOf("refundtotal")
batchid = jsonResp.stringOf("batchid")
chargetotal = jsonResp.stringOf("chargetotal")
hoststat = jsonResp.stringOf("hoststat")
merchid = jsonResp.stringOf("merchid")
i = 0
count_i = jsonResp.SizeOfArray("txns")
while i < count_i
    jsonResp.put_I(i)
    setlamount = jsonResp.stringOf("txns[i].setlamount")
    setlstat = jsonResp.stringOf("txns[i].setlstat")
    salesdoc = jsonResp.stringOf("txns[i].salesdoc")
    retref = jsonResp.stringOf("txns[i].retref")
    i = i + 1
end