Xojo Plugin

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

Xojo Plugin

Dim success As Boolean
success = False

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

Dim http As New Chilkat.Http

http.BasicAuth = True
http.Login = "API_USERNAME"
http.Password = "API_PASSWORD"

Dim url As String
url = "https://<site>.cardconnect.com:<port>/cardconnect/rest/settlestat?merchid=<merchid>&batchid=<batchid>"
Dim responseStr As String
responseStr = http.QuickGetStr(url)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// 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.
System.DebugLog("response status code = " + Str(http.LastStatus))

Dim jsonResp As New Chilkat.JsonObject
success = jsonResp.Load(responseStr)
jsonResp.EmitCompact = False

System.DebugLog("response JSON:")
System.DebugLog(jsonResp.Emit())

// 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

Dim setlamount As String
Dim setlstat As String
Dim salesdoc As String
Dim retref As String

Dim respproc As String
respproc = jsonResp.StringOf("respproc")
Dim hostbatch As String
hostbatch = jsonResp.StringOf("hostbatch")
Dim refundtotal As String
refundtotal = jsonResp.StringOf("refundtotal")
Dim batchid As String
batchid = jsonResp.StringOf("batchid")
Dim chargetotal As String
chargetotal = jsonResp.StringOf("chargetotal")
Dim hoststat As String
hoststat = jsonResp.StringOf("hoststat")
Dim merchid As String
merchid = jsonResp.StringOf("merchid")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jsonResp.SizeOfArray("txns")
While i < count_i
    jsonResp.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
Wend