Tcl

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

Tcl

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "API_USERNAME"
CkHttp_put_Password $http "API_PASSWORD"

set url "https://<site>.cardconnect.com:<port>/cardconnect/rest/settlestat?merchid=<merchid>&batchid=<batchid>"
set responseStr [CkHttp_quickGetStr $http $url]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# 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.
puts "response status code = [CkHttp_get_LastStatus $http]"

set jsonResp [new_CkJsonObject]

CkJsonObject_Load $jsonResp $responseStr
CkJsonObject_put_EmitCompact $jsonResp 0

puts "response JSON:"
puts [CkJsonObject_emit $jsonResp]

# 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

set respproc [CkJsonObject_stringOf $jsonResp "respproc"]
set hostbatch [CkJsonObject_stringOf $jsonResp "hostbatch"]
set refundtotal [CkJsonObject_stringOf $jsonResp "refundtotal"]
set batchid [CkJsonObject_stringOf $jsonResp "batchid"]
set chargetotal [CkJsonObject_stringOf $jsonResp "chargetotal"]
set hoststat [CkJsonObject_stringOf $jsonResp "hoststat"]
set merchid [CkJsonObject_stringOf $jsonResp "merchid"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResp "txns"]
while {$i < $count_i} {
    CkJsonObject_put_I $jsonResp $i
    set setlamount [CkJsonObject_stringOf $jsonResp "txns[i].setlamount"]
    set setlstat [CkJsonObject_stringOf $jsonResp "txns[i].setlstat"]
    set salesdoc [CkJsonObject_stringOf $jsonResp "txns[i].salesdoc"]
    set retref [CkJsonObject_stringOf $jsonResp "txns[i].retref"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $jsonResp